Skip to content

Commit 7c570e6

Browse files
committed
feat!: use cz-conventional-changelog as default adapter
1 parent 3402fdd commit 7c570e6

File tree

3 files changed

+94
-81
lines changed

3 files changed

+94
-81
lines changed

Diff for: README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,13 @@ When you're working in a Commitizen friendly repository, you'll be prompted to f
4343

4444
[![Add and commit with Commitizen](https://github.com/commitizen/cz-cli/raw/master/meta/screenshots/add-commit.png)](https://github.com/commitizen/cz-cli/raw/master/meta/screenshots/add-commit.png)
4545

46-
### If your repo is NOT Commitizen friendly:
46+
### If your repo is NOT Commitizen-friendly
4747

48-
If you're **not** working in a Commitizen friendly repository, then `git cz` will work just the same as `git commit` but `npx cz` will use the [streamich/git-cz](https://github.com/streamich/git-cz) adapter. To fix this, you need to first [make your repo Commitizen-friendly](#making-your-repo-commitizen-friendly)
48+
If you're **not** working in a Commitizen friendly repository, then `git cz` will work just the same as `git commit` but `npx cz` will use the [cz-conventional-changelog](https://github.com/commitizen/cz-conventional-changelog) adapter. To fix this, you need to first [make your repo Commitizen-friendly](#making-your-repo-commitizen-friendly).
4949

5050
## Making your repo Commitizen-friendly
5151

52-
For this example, we'll be setting up our repo to use [AngularJS's commit message convention](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines) also known as [conventional-changelog](https://github.com/ajoslin/conventional-changelog).
52+
For this example, we'll be setting up our repo to use [Conventional Commits convention](https://www.conventionalcommits.org/) through the[conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) [commitizen adapter](https://github.com/commitizen/cz-conventional-changelog).
5353

5454
First, install the Commitizen cli tools:
5555

Diff for: package-lock.json

+90-77
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
},
7575
"dependencies": {
7676
"cachedir": "2.2.0",
77-
"cz-conventional-changelog": "3.2.0",
77+
"cz-conventional-changelog": "3.3.0",
7878
"dedent": "0.7.0",
7979
"detect-indent": "6.0.0",
8080
"find-node-modules": "2.0.0",

0 commit comments

Comments
 (0)