diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a2ae792c..a6289067 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -155,7 +155,13 @@ Please don't include more than one change in each patch. If your commit message We have very precise rules over how our git commit messages can be formatted. This leads to **more readable messages** that are easy to follow when looking through the **project history**. We also use the git commit messages to **generate the change log**. -The commit message format validation can be initialised by running `npm run init` from the root of the repository. This will add a symlink at `.git/hooks/commit-msg` which will be run every time you commit. +We use [husky](https://www.npmjs.com/package/husky) and [validate-commit-msg](https://github.com/kentcdodds/validate-commit-msg) to perform the commit message validation. Commit messages will be validated when you commit. When validation fails, you'll see a message similar to the following: + +```bash +> husky - npm run -s commitmsg + +INVALID COMMIT MSG: does not match "(): " ! +``` #### Line Length