Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

31 lines (20 loc) · 1.14 KB

Contributing to cyclops

Thanks for your interest in contributing to cyclops!

To submit PRs, please fill out the PR template along with the PR. If the PR fixes an issue, don't forget to link the PR to the issue!

Pre-commit hooks

Once the python virtual environment is setup, you can run pre-commit hooks using:

pre-commit run --all-files

Coding guidelines

For code style, we recommend the google style guide.

Pre-commit hooks apply the black code formatting.

For docstrings we use numpy format.

We also use flake8 and pylint for further static code analysis. The pre-commit hooks show errors which you need to fix before submitting a PR.

Last but not the least, we use type hints in our code which is then checked using mypy. Currently, mypy checks are not strict, but will be enforced more as the API code becomes more stable.