From e5bf6fd1ccb95d8ad97820b2199193c0bec0e344 Mon Sep 17 00:00:00 2001 From: Twirre Meulenbelt <43213592+TwirreM@users.noreply.github.com> Date: Sun, 2 Nov 2025 20:40:32 +0100 Subject: [PATCH] docs: update README instructions for git hooks Removed old advice from the README to configure git to add pre-commit hooks manually. We now have `pre-commit` for this, and they conflict. Added the command to install commit message hooks. ref: N25B-241 --- README.md | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 45f8f98..a79f138 100644 --- a/README.md +++ b/README.md @@ -49,19 +49,9 @@ uv run --group integration-test pytest test/integration ## GitHooks -To activate automatic commits/branch name checks run: - -```shell -git config --local core.hooksPath .githooks -``` - -If your commit fails its either: -branch name != /description-of-branch , -commit name != : description of the commit. - : N25B-Num's - -To add automatic linting and formatting, run: +To activate automatic linting, formatting, branch name checks and commit message checks, run: ```shell uv run pre-commit install -``` \ No newline at end of file +uv run pre-commit install --hook-type commit-msg +```