Skip to content

Commit

Permalink
feat!: use cz-conventional-changelog as default adapter
Browse files Browse the repository at this point in the history
  • Loading branch information
felipecrs committed Sep 14, 2020
1 parent 3402fdd commit 7c570e6
Show file tree
Hide file tree
Showing 3 changed files with 94 additions and 81 deletions.
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -43,13 +43,13 @@ When you're working in a Commitizen friendly repository, you'll be prompted to f

[![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)

### If your repo is NOT Commitizen friendly:
### If your repo is NOT Commitizen-friendly

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)
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).

## Making your repo Commitizen-friendly

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).
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).

First, install the Commitizen cli tools:

Expand Down
167 changes: 90 additions & 77 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -74,7 +74,7 @@
},
"dependencies": {
"cachedir": "2.2.0",
"cz-conventional-changelog": "3.2.0",
"cz-conventional-changelog": "3.3.0",
"dedent": "0.7.0",
"detect-indent": "6.0.0",
"find-node-modules": "2.0.0",
Expand Down

0 comments on commit 7c570e6

Please sign in to comment.