From 28ecf7c865173df643a15df6582f458a2b1ac8e5 Mon Sep 17 00:00:00 2001 From: Tims777 Date: Wed, 14 Feb 2024 15:32:47 +0100 Subject: [PATCH] Update Build-Documentation.md Signed-off-by: Tims777 --- Documentation/Build-Documentation.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/Documentation/Build-Documentation.md b/Documentation/Build-Documentation.md index c92a1b5..adb0a04 100644 --- a/Documentation/Build-Documentation.md +++ b/Documentation/Build-Documentation.md @@ -58,3 +58,21 @@ be started via ```bash pipenv run python src/main.py ``` + +# Pre-Commit Hooks + +This repository uses `pre-commit` hooks to ensure a consistent and clean file organization. Each registered hook will be executed when committing to the repository. To ensure that the hooks will be executed they need to be installed using the following command: + +```bash +pre-commit install +``` + +The following things are done by hooks automatically: + +- formatting of python files using black and isort +- formatting of other files using prettier +- syntax check of JSON and yaml files +- adding new line at the end of files +- removing trailing whitespaces +- prevent commits to `dev` and `main` branch +- check adherence to REUSE licensing format