Skip to content

Commit 30edb29

Browse files
Merge pull request #88 from alessandrojcm/chore/v9
Update to commitlint v17
2 parents 529a45e + 9a820fc commit 30edb29

File tree

3 files changed

+443
-392
lines changed

3 files changed

+443
-392
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@
1111
- id: commitlint
1212
stages: [commit-msg]
1313
```
14-
* If you are using one of Commitlint's [shared configurations](https://commitlint.js.org/#/reference-configuration?id=shareable-configuration),
15-
add it to the `additional_dependencies` parameter of the hooks, i.e:
14+
* Add your [shared configurations](https://commitlint.js.org/#/reference-configuration?id=shareable-configuration) as a
15+
dependency using the `additional_dependencies` parameter of the hooks, here we use the `@commitlint/config-angular`
16+
as an example:
1617
```
1718
- repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
1819
rev: <latest tag>
@@ -25,6 +26,9 @@
2526
```shell
2627
pre-commit install --hook-type commit-msg
2728
```
29+
30+
Note that you **need** to specify a shared configuration in order for `commitlint` to work, if `commitlint` is new to you
31+
just use their default configuration (`@commitlint/config-conventional`). For more information, refer to their [docs](https://commitlint.js.org/#/?id=getting-started).
2832
2933
### Usage in Travis CI
3034

0 commit comments

Comments
 (0)