CONTRIBUTING.md

Contributing

Code style and format

We use black to automatically format our python files. Please stick to the black code style.

Please consider using the pre-commit hooks. They automatically run i.a. black for you. See next section.

Black quick-installation guide

pip install black
black

Running pre-commit hooks

We use pre-commit to run some checks on your files before they are commited. Find the configured hooks in .pre-commit-config.yaml. If there are errors, you have to re-add the files to the index and commit the fixed files.

Pre-commit quick-installation guide

pip install pre-commit
pre-commit install

Optionally, cou can then run the hooks against all files with:

pre-commit run --all-files