Skip to content

Commit 2f5ef25

Browse files
authored
docs: add links to configuration guides
1 parent 5431899 commit 2f5ef25

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,16 @@
1616
## Getting started
1717

1818
```sh
19+
# Install commitlint cli and angular config
1920
npm install --save-dev @commitlint/{config-angular,cli}
21+
22+
# Configure commitlint to use angular config
2023
echo "module.exports = {extends: ['@commitlint/config-angular']}" > commitlint.config.js
2124
```
2225

26+
* [Local setup](http://marionebl.github.io/commitlint/#/guides-local-setup) - Lint messages on commit with husky
27+
* [CI setup](http://marionebl.github.io/commitlint/#/guides-ci-setup) - Lint messages during CI builds
28+
2329
## CLI
2430

2531
* Primary way to interact with commitlint.

0 commit comments

Comments
 (0)