- File an issue to notify the maintainers about what you're working on.
- Fork the repo, develop and test your code changes, add docs.
- Make sure that your commit messages clearly describe the changes.
- Send a pull request.
Be sure to add the relevant tests before making the pull request. Docs will be
updated automatically when we merge to master
, but you should also build
the docs yourself and make sure they're readable.
Once you have made all your changes, tests, and updated the documentation,
make a pull request to move everything back into the main branch of the
repository
. Be sure to reference the original issue in the pull request.
Expect some back-and-forth with regards to style and compliance of these
rules.