Continuous Integration

Code styleguide

This project’s code formatting is enforced with black and isort for Python, and Prettier for supported languages. Make sure to have these integrated with your editor to auto-format when saving files, or to manually run them before committing (black ., isort . , npm run format).

Automatic linting locally

You can also optionally run the linting tests automatically before committing via git hooks and pre-commit.

Pre-commit will not run by default. To set it up, run pre-commit install inside the Docker container, or on the host if you have installed pre-commit there.

The detect-secrets pre-commit hook requires a baseline secrets file to be included. If you need to, you can update this file, e.g. when adding dummy secrets for unit tests:

detect-secrets scan > .secrets.baseline