docs: add suggested fix for potential issue
ref: N25B-241
This commit is contained in:
12
README.md
12
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.
|
||||
|
||||
Reference in New Issue
Block a user