CONTRIBUTING.md

Contributing to bootcamp_template

Thanks for your interest in contributing to the bootcamp_template!

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 docstrings we use numpy format.

For code style, we recommend the PEP 8 style guide. Pre-commit hooks apply black code formatting.

We use ruff for code formatting and static code analysis. Ruff checks various rules including flake8. 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.