Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 944 Bytes

DEVELOPMENT.md

File metadata and controls

28 lines (18 loc) · 944 Bytes

Development

Pre-Commit

Used for maintaining pre-commit hooks.

It must be installed on the system level. It is not installed automatically with Poetry. Also don't forget to execute pre-commit install if you haven't initialized pre-commit before.

Pre-commit is configured via .pre-commit-config.yaml. It should automatically run on every commit.

To trigger pre-commit manually, execute pre-commit run --all-files.

Pre-commit is also run as part of the CI/CD pipeline.

Several of the defined hooks are local using dependencies installed via Poetry. This means that you can also use tools like black, yapf, and mypy directly.

Shell Scripts

In ./bin you can find a bunch of small Shell scripts that provide useful utilites. Every script has a description that can be accessed with the --help or -h option.