Skip to content

Latest commit

 

History

History
64 lines (43 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

64 lines (43 loc) · 2.36 KB

Contributing to novicebot

We ❤️ input from you all awesome developers! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a issue
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

All Changes Happen Through Pull Requests

Pull requests are the best way to propose changes. We actively welcome your pull requests:

  1. Fork the repo and create your branch from main. Create your branch in the following format.
$ git checkout -b yourname/branchname
  1. If you've added code that should be tested, add some test examples.
  2. If you've changed APIs or used some new APIs for new features, update the documentation.
  3. Issue that pull request!

Local Development

To run Zoro aka novicebot you need to follow few simple steps :-

Want to be a maintainer?

  • Feel free to contact us. We would ❤️ help from you all!
  • The only requirement is be ready to collaborate and be nice to everyone

Any contributions you make will be under the MIT Software License

In short, when you submit changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report issues/bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Bug Reports

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Share the snapshot, if possible.
  • What actually happens
  • What you expected would happen
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Feature Request

Great Feature Requests tend to have:

  • A quick idea summary
  • What & why you wanted to add the specific feature
  • Additional Context like images, links to resources to implement the feature etc etc.

License

By contributing, you agree that your contributions will be licensed under its MIT License.