From e025b146100987f9c78d37c8e57ea44fc8aeb683 Mon Sep 17 00:00:00 2001 From: Twirre Meulenbelt <43213592+TwirreM@users.noreply.github.com> Date: Sun, 2 Nov 2025 20:54:38 +0100 Subject: [PATCH] docs: add suggested fix for potential issue ref: N25B-241 --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a79f138..d20b36d 100644 --- a/README.md +++ b/README.md @@ -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.