Skip to content

Commit

Permalink
fix(docs): mention commitizen
Browse files Browse the repository at this point in the history
  • Loading branch information
czosel committed Apr 21, 2019
1 parent 5762994 commit fbf77c2
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,27 @@ and adding the following section to `package.json`:

- Add credentials for GitHub and npm as described [here](https://semantic-release.gitbook.io/semantic-release/usage/ci-configuration))
- Run semantic-release in the deploy stage as described [here](https://semantic-release.gitbook.io/semantic-release/recipes/recipes/travis)

## Commitizen

Optionally, you can also set up [commitizen](https://github.com/commitizen/cz-cli) for a more interactive way of adding commits:

```
$ git cz
? Select the type of change that you're committing:
? What is the scope of this change (e.g. component or file name)?
? Write a short, imperative tense description of the change:
? Provide a longer description of the change: (press enter to skip)
? Are there any breaking changes? No
? Does this change affect any open issues? No
```

Setup is simple:

```
npm install -g commitizen
commitizen init cz-conventional-changelog --yarn --dev --exact
```

After, run `git cz` instead of `git commit`.

0 comments on commit fbf77c2

Please sign in to comment.