Project contributions are more than welcome! We want to make contributing to this project as easy and transparent as possible. When you submit code changes, your submissions are understood to be under the same license that covers the project. Feel free to contact the maintainers if that's a concern.
Reporting bugs helps us to identify issues and provide patches and therefore to make the software more stable and useful. We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
Pull requests are the best way to propose changes to the codebase (we use the Github flow). We actively welcome your pull requests:
- Fork the repo and create your branch from master.
- If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
To propose a change to documentation, edit the documentation source files in the docs directory. Then open a pull request with the proposed changes.
Our release procedure is described here.
This document was adapted from the open-source contribution guidelines for Facebook's Draft.