Contribution
How to Contribute
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Make your changes
- Run
pre-commit run --all-files
to run all hooks on all files. - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) -
Open a Pull Request
-
Pull requests must be reviewed by at least one other person before being merged.
- Pull requests must pass all checks before being merged.
- If you have access to the slack channel, please post a link to your PR in the slack channel, that is the fastest way to get it reviewed.
Specifications
Reminders
- Be sure to write tests for your code. These are within the
tests
directory. - Your PR will not be merged if it does not pass all tests.
- Be sure to write docstrings for your code.
- You have to re-run
git add
after the pre-commit hook runs. - Pull requests must be reviewed by at least one other person before being merged.