docs: add suggested fix for potential issue

ref: N25B-241
This commit is contained in:
Twirre Meulenbelt
2025-11-02 20:54:38 +01:00
parent e5bf6fd1cc
commit e025b14610

View File

@@ -47,11 +47,19 @@ Or for integration tests:
uv run --group integration-test pytest test/integration
```
## GitHooks
## Git Hooks
To activate automatic linting, formatting, branch name checks and commit message checks, run:
```shell
```bash
uv run pre-commit install
uv run pre-commit install --hook-type commit-msg
```
You might get an error along the lines of `Can't install pre-commit with core.hooksPath` set. To fix this, simply unset the hooksPath by running:
```bash
git config --local --unset core.hooksPath
```
Then run the pre-commit install commands again.