Skip to content

Commit

Permalink
Update Build-Documentation.md
Browse files Browse the repository at this point in the history
Signed-off-by: Tims777 <[email protected]>
  • Loading branch information
Tims777 committed Feb 14, 2024
1 parent 7ffc7e7 commit 28ecf7c
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions Documentation/Build-Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 28ecf7c

Please sign in to comment.