- Fork this repository
- Create a branch for your fix of an issue/feature/doc (
git checkout -b my-fix) - Stage your changes, run
pre-commit, and runpytestuntil every thing looks fine - Commit your changes (
git commit -am 'Added some feature/fix/doc') - Push to the branch (
git push origin my-fix) - Create new Pull Request
For code quality control, we use pre-commit hooks for formatting and type hints.
Try your best to add test cases for bug fixes and new features. We use pytest for testing.
For documentation, we should try to follow the Google Python docstrings style.