From 7789bff83fc232ef7bca7050088520e6e45cc4fe Mon Sep 17 00:00:00 2001 From: Jan K9f Date: Fri, 4 Apr 2025 07:40:27 +0200 Subject: [PATCH] feat(commitizen): add commitizen docs --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index ce8b529..cd435eb 100644 --- a/README.md +++ b/README.md @@ -156,6 +156,16 @@ Where `` 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