feat(commitizen): add commitizen docs
All checks were successful
CI / Get Changed Files (pull_request) Successful in 6s
CI / Checkstyle Main (pull_request) Has been skipped
CI / eslint (pull_request) Has been skipped
CI / prettier (pull_request) Has been skipped
CI / test-build (pull_request) Has been skipped

This commit is contained in:
Jan K9f 2025-04-04 07:40:27 +02:00
commit 7789bff83f
Signed by: jank
GPG key ID: 22BEAC760B3333D6

View file

@ -156,6 +156,16 @@ Where `<type>` is one of:
- `test`: Adding or refactoring tests
- `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:
```
feat: add user balance display