Skip to content

Commitizen

Pain point

Unstructured commit messages make history difficult to scan and prevent reliable automation from understanding whether a change is a feature, fix, documentation update, or maintenance task.

Official source: commitizen-tools/commitizen

The configured commitizen hook runs at the commit-msg stage. Unlike file hooks, it receives the temporary file containing the proposed commit message and validates that message before Git creates the commit.

Why it is included

This repository follows Conventional Commits. Structured messages make history easier to scan and can later support release notes, changelogs, and semantic versioning without requiring those release features today.

Failure and resolution

A failure means the final message does not follow the accepted convention. Rewrite it in this form:

<type>[optional scope]: <description>

Use cz commit for an interactive prompt, or validate a message directly with cz check --message. The project-entry automation installs the commit-msg Git hook so ordinary git commit commands are validated automatically.

See Commitizen's official automatic checking guide and commit command.