Skip to content

Latest commit

 

History

History
50 lines (36 loc) · 2.4 KB

CONTRIBUTING.md

File metadata and controls

50 lines (36 loc) · 2.4 KB
Raw

Contributing to our project

We love your input! We want to make contributing to this project 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
  • Becoming a maintainer

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from develop.
  2. If you've added code that should be tested, add tests.
  3. If you've modified any user facing function, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints (use black).
  6. Issue that pull request!

Any contributions you make will be under the GPL-3.0 Software License

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

Report 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!

Write bug reports with detail, background, and sample code (if possible)

Great Bug Reports tend to have:

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

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

Use a Consistent Coding Style

I'm again asking you to use black

License

By contributing, you agree that your contributions will be licensed under GPL-3.0 License.

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft