From 6a1dbfbda156db9442e0d180131e42185d181f2a Mon Sep 17 00:00:00 2001 From: SyedTayyabUlMazhar <43899564+SyedTayyabUlMazhar@users.noreply.github.com> Date: Wed, 13 Dec 2023 00:44:21 +0500 Subject: [PATCH] Update README.md Explicitly mention that the hook file name must be commit-msg for husky --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 576f27117b..a86ea33eb4 100644 --- a/README.md +++ b/README.md @@ -108,7 +108,9 @@ yarn husky install ``` ### Add hook - +> [!WARNING] +> It's necessary that you use **commit-msg** as the name for hook file. +> Read Git hooks [documentation](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) for more info. ``` npx husky add .husky/commit-msg 'npx --no -- commitlint --edit ${1}' ```