Skip to content

Commit 6ae9859

Browse files
docs: fix pre-commit instructions
1 parent fe8b3bc commit 6ae9859

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

docs/source/contributing.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@
55

66
### Setup pre-commit hooks
77
- Install pre-commit hooks with `pip install pre-commit`.
8-
- Run `pre-commit autoupdate` once to configure the hooks.
9-
- Re-run `pre-commit autoupdate` every time a new hook got added.
8+
- Run `pre-commit install` once to install the hooks, so they will be run on every commit.
9+
- If the hooks introduce changes, they'll be visible with `git diff`. Review them and `git add` them if everything is fine, then re-execute the before commit, it should pass now.
10+
- If you want to manually trigger the hooks, you may do `pre-commit run --all-files`
1011

1112
Now all the pre-commit hooks will be automatically run when you try to commit and if they introduce some changes, you need to re-add the changed files before being able to commit and push.
1213

0 commit comments

Comments
 (0)