Running

As mentioned in the Precommit page, this should be installed with each CHIME repository's Poetry virtual environment. In other words, run

poetry shell

to then use cz or use

poetry run cz

if you're not in the Poetry virtual environment shell.

If you'd like to have Commitzen installed globally on your local deivce, you can simply install it with pip, using:

pip install commitizen

After you have staged your changes with git add, you can now run

cz c

or

cz commit

to open an interactive prompt that will help you build the standardized commit message.

Output

Note

It is very important to use Commitzen on all your commits, so that every commit is traceable in the auto-generated CHANGELOG.md, and so that proper releases, tags, and versioning can be done through GitHub actions bots!

Commit stopped by Precommit?

Once the issues have been resolved, you can run Commitizen again with the same answers to the prompts by running:

git add {resolved_files}
cz c --retry