Skip to content

Commit 83f18ae

Browse files
docs: mention hook file name must be commit-msg for husky (#3822)
Explicitly mention that the hook file name must be commit-msg for husky
1 parent b0d2a57 commit 83f18ae

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,9 @@ yarn husky install
108108
```
109109

110110
### Add hook
111-
111+
> [!WARNING]
112+
> It's necessary that you use **commit-msg** as the name for hook file.
113+
> Read Git hooks [documentation](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) for more info.
112114
```
113115
npx husky add .husky/commit-msg 'npx --no -- commitlint --edit ${1}'
114116
```

0 commit comments

Comments
 (0)