pepperplus/pepperplus-cb
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: update README instructions for git hooks

Browse Source 
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
This commit is contained in:
Twirre Meulenbelt
2025-11-02 20:40:32 +01:00
parent 460dc5dce8
commit e5bf6fd1cc
1 changed files with 3 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -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 != <type>/description-of-branch ,
commit name != <type>: description of the commit.
<ref>: 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
```
uv run pre-commit install --hook-type commit-msg
```