Skip to content

Latest commit

 

History

History
56 lines (35 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

56 lines (35 loc) · 2.16 KB

Contributing to this repository

Contributing to this project should be as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features

IMPORTANT! Install development environment first

When making changes in code, please use the existing development environment — this will save you from many errors and help create more convenient code to support.

To install the environment, run the ./bin/setup script.

Github is used for everything

Github is used to host code, to track issues and feature requests, as well as accept pull requests.

Pull requests are the best way to propose changes to the codebase.

  1. Fork the repo and create your branch from master.
  2. If you've changed something, update the documentation.
  3. Make sure your code lints (using black).
  4. Issue that pull request!

Report bugs using Github's issues

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

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

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

People love thorough bug reports. I'm not even kidding.

Use a Consistent Coding Style

Use black to make sure the code follows the style.

This program (and not only this) is automatically applied on code commit if you set up the developer environment as indicated at the beginning of this document. Please make this set up. It will greatly facilitate your work.

License

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

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