Skip to content

Commit f0a3e55

Browse files
committed
chore(docs): add introduction for commitizen, cz-customizable, commitlint
1 parent 71d026f commit f0a3e55

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,13 @@ commitlint-config-cz use only one config in the following order of precedence.
2222

2323
## Installation
2424

25-
Install `commitlint-config-cz` as a local dependency.
25+
1. [Install & setup (commitizen &) cz-customizable.][cz-customizable]
26+
2. [Install commitlint.][commitlint-getting-started]
27+
3. Install `commitlint-config-cz` as a local dependency.
2628

27-
```sh
28-
npm install commitlint-config-cz --save-dev
29-
```
29+
```sh
30+
npm install commitlint-config-cz --save-dev
31+
```
3032

3133
## Usage
3234

@@ -162,6 +164,7 @@ const types = getTypes(czConfig);
162164
````
163165
164166
[commitlint]: https://github.com/conventional-changelog/commitlint
167+
[commitlint-getting-started]: https://github.com/conventional-changelog/commitlint#getting-started
165168
[cz-customizable]: https://github.com/leonardoanalista/cz-customizable
166169
[commitizen]: https://github.com/commitizen/cz-cli
167170
[conventional-commits]: https://www.conventionalcommits.org

0 commit comments

Comments
 (0)