Contributing to cycquery

Thanks for your interest in contributing to cycquery tool!

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

For code style, we recommend the google style guide.

Pre-commit hooks apply the black code formatting.

For docstrings we use numpy format.

We use ruff 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.