Commit Message Standards¶
Good commit messages make the history useful. They explain why a change was made, not just what changed.
Format¶
<type>: <short description>
<optional body — explain why, not what>
Types¶
| Type | When to use |
|---|---|
feat |
New feature |
fix |
Bug fix |
refactor |
Code restructuring without behaviour change |
test |
Adding or updating tests |
docs |
Documentation changes |
chore |
Maintenance, dependency updates, tooling |
perf |
Performance improvements |
Good vs Poor Examples¶
Good:
fix: prevent duplicate records on pipeline retry
Idempotency key was not being checked before insert,
causing duplicates when the pipeline retried on timeout.
Poor:
fix bug