From bea156392d55f85111a44c179460e111d05a137a Mon Sep 17 00:00:00 2001 From: Serghei Iakovlev Date: Sat, 4 Mar 2023 00:30:56 +0100 Subject: [PATCH] doc: improve commit messages guide --- CONTRIBUTING.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 269f13b59..35af2b288 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,15 +37,20 @@ Take a look at the git history (`git log`) to get the gist of it. If you'd like to get some CLI assistance there is a node npm package. Example usage is: -``` +```shell npm install -g commitizen npm install -g cz-conventional-changelog +echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc ``` -`git cz` to commit and `commitizen` will guide you. +When you commit with Commitizen, you'll be prompted to fill out any required +commit fields at commit time. Simply use `git cz` or just `cz` instead of +`git commit` when committing. You can also use `git-cz`, which is an alias +for `cz`. + +See https://www.npmjs.com/package/commitizen for more info. There is a pypi package that does similar [commitizen](https://pypi.org/project/commitizen/). -This would make a great feature to add! ## Running the tests