feat(commitizen): add commitizen docs
All checks were successful
All checks were successful
This commit is contained in:
parent
4eb644d69d
commit
7789bff83f
1 changed files with 10 additions and 0 deletions
10
README.md
10
README.md
|
@ -156,6 +156,16 @@ Where `<type>` is one of:
|
||||||
- `test`: Adding or refactoring tests
|
- `test`: Adding or refactoring tests
|
||||||
- `chore`: Updating build tasks, etc; no production code change
|
- `chore`: Updating build tasks, etc; no production code change
|
||||||
|
|
||||||
|
You may use [commitizen](https://commitizen-tools.github.io/commitizen/) to automatically validate or write your commits:
|
||||||
|
|
||||||
|
After installing [commitizen](https://commitizen-tools.github.io/commitizen/) you may commit with:
|
||||||
|
```
|
||||||
|
cz c
|
||||||
|
```
|
||||||
|
This will automatically ask you some questions and generate a semantic commit for you.
|
||||||
|
|
||||||
|
You may additionally install [pre-commit](https://pre-commit.com/). This will automatically validate your commits before push and commiting.
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
```
|
```
|
||||||
feat: add user balance display
|
feat: add user balance display
|
||||||
|
|
Reference in a new issue