Skip to content

Contribution

How to Contribute

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Make your changes
  4. Run pre-commit run --all-files to run all hooks on all files.
  5. Commit your Changes (git commit -m 'Add some AmazingFeature')
  6. Push to the Branch (git push origin feature/AmazingFeature)
  7. Open a Pull Request

  8. Pull requests must be reviewed by at least one other person before being merged.

  9. Pull requests must pass all checks before being merged.
  10. 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.