add-commitizen #124

Closed
jank wants to merge 2 commits from add-commitizen into main
3 changed files with 23 additions and 0 deletions

5
.cz.toml Normal file
View file

@ -0,0 +1,5 @@
[tool.commitizen]
name = "cz_conventional_commits"
tag_format = "v$version"
version_scheme = "semver"
version_provider = "scm"

8
.pre-commit-config.yaml Normal file
View file

@ -0,0 +1,8 @@
repos:
- hooks:
- id: commitizen
- id: commitizen-branch
stages:
- push
repo: https://github.com/commitizen-tools/commitizen
rev: v4.4.1

View file

@ -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