Skip to content

Commit 0145dec

Browse files
committed
docs: document opt-in git hooks setup in CONTRIBUTING
1 parent 81af0e6 commit 0145dec

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@ To create a release build of Vite+ and all upstream dependencies, run:
5353
just build
5454
```
5555

56+
## Git Hooks (optional)
57+
58+
Pre-commit checks are opt-in. Run `vp config` after a build to install the hook dispatcher; each commit then runs `vp staged` on staged files. `vp staged` loads its config from `vite.config.ts` and needs the built JS packages, so build first. Opt out with `vp hooks disable`, or skip one run with `VP_GIT_HOOKS=0`. If husky was active in your clone before, run `git config --unset core.hooksPath` once first.
59+
5660
## Install the Vite+ Global CLI from source code
5761

5862
```bash

0 commit comments

Comments
 (0)