File tree Expand file tree Collapse file tree 1 file changed +9
-3
lines changed Expand file tree Collapse file tree 1 file changed +9
-3
lines changed Original file line number Diff line number Diff line change @@ -29,7 +29,9 @@ It also includes a set of utilities for customizing rules.
29
29
30
30
## When should I use this?
31
31
32
- ** TODO** : use cases.
32
+ This package can be used with [ ` @commitlint/cli ` ] [ 3 ] and [ ` @commitlint/prompt-cli ` ] [ 4 ] .
33
+
34
+ Commit parsing options can also be used with [ ` conventional-changelog ` ] [ 5 ] and [ ` conventional-commits-parser ` ] [ 6 ] .
33
35
34
36
## Install
35
37
@@ -60,12 +62,16 @@ yarn add -D @flex-development/commitlint-config@flex-development/commitlint-conf
60
62
61
63
## Types
62
64
63
- This package is fully typed with [ TypeScript] [ 3 ] .
65
+ This package is fully typed with [ TypeScript] [ 7 ] .
64
66
65
67
## Contribute
66
68
67
69
See [ ` CONTRIBUTING.md ` ] ( CONTRIBUTING.md ) .
68
70
69
71
[ 1 ] : https://commitlint.js.org/
70
72
[ 2 ] : https://conventionalcommits.org/
71
- [ 3 ] : https://www.typescriptlang.org
73
+ [ 3 ] : https://commitlint.js.org/#/reference-cli
74
+ [ 4 ] : https://commitlint.js.org/#/guides-use-prompt
75
+ [ 5 ] : https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog
76
+ [ 6 ] : https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser
77
+ [ 7 ] : https://www.typescriptlang.org
You can’t perform that action at this time.
0 commit comments