Skip to content

[docs] Fix Husky setup instructions #428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 3, 2018
Merged

[docs] Fix Husky setup instructions #428

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,13 @@ echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitl
```


To lint commits before they are created you can use the 'commitmsg' hook as described [here](https://github.com/typicode/husky/blob/master/HOOKS.md#hooks)

To lint commits before they are created you can use Husky's 'commit-msg' hook:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why removing the link to https://github.com/typicode/husky/blob/master/HOOKS.md#hooks ?

And:

[...] you can use Husky's 'commit-msg' hook

In the code it's commitmsg not commit-msg. That might be confusing.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in #429

```json
{
"scripts": {
"commitmsg": "commitlint -E GIT_PARAMS"
"husky": {
"hooks": {
"commitmsg": "commitlint -E HUSKY_GIT_PARAMS"
}
}
}
```
Expand Down