Skip to content

Commit

Permalink
chore: update contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
jimlambie committed Apr 21, 2017
1 parent b88cf37 commit fea26f8
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
Expand Up @@ -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 "<type>(<scope>): <subject>" !
```

#### Line Length

Expand Down

0 comments on commit fea26f8

Please sign in to comment.