Skip to content

Commit bf99c0b

Browse files
committed
Update README with information about pre-commit
1 parent af67389 commit bf99c0b

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,3 +97,16 @@ files.
9797

9898
To upgrade Storybook when it informs you about new version being available, run
9999
the given `npx sb@latest upgrade` command in `apps/storybook` directory.
100+
101+
## pre-commit
102+
103+
[Pre-commit](https://pre-commit.com/) enforces code style practices in this
104+
project. Choose your preferred
105+
[installation method](https://pre-commit.com/#install) and then run `pre-commit
106+
install` to enable Git hook scripts. Pre-commit will now automatically cancel
107+
your commits if any problems are detected, and autofix them. Stage the changed
108+
files to your commit and re-run the commit command.
109+
110+
Pre-commit can be disabled for a single commit with `--no-verify` option, but
111+
note that CI also runs pre-commit and will fail if any problems are encountered
112+
at this stage.

0 commit comments

Comments
 (0)