Skip to content

Commit 6cea17f

Browse files
docs: add deprecation note on cz-config.js
1 parent 56c021a commit 6cea17f

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,9 @@ Suitable for large teams working with multiple projects with their own commit sc
4141
```
4242
Note: option one allows you to have your config away from root directory. It also gives you a change to define any name to your `cz-config.js`.
4343

44-
* Option 2: Run `cp ./node_modules/cz-customizable/cz-config-EXAMPLE.js ./.cz-config.js` in a project root directory to get a template.
45-
Note: if you chose option 2, config file has to be called `.cz-config.js`.
44+
* Option 2: (**DEPRECATED** in order to align configuration with Commitizen. Please use option 1)
45+
Run `cp ./node_modules/cz-customizable/cz-config-EXAMPLE.js ./.cz-config.js` in a project root directory to get a template.
46+
Note: if you chose option 2, config file has to be called `.cz-config.js`. This option will be removed after the next major release.
4647

4748

4849
**Notes:**

0 commit comments

Comments
 (0)