Conventional Commits cheat-sheet
The spec CommitLift lints against — conventionalcommits.org 1.0.0.
| Rule | Detail |
|---|---|
| Header | type(scope)!: description — the ! signals a BREAKING CHANGE. |
| Types | feat · fix · docs · style · refactor · test · chore |
| Scope | Optional noun describing the part of the codebase (auth, api, ui). Lowercase, hyphens. |
| Description | Imperative mood, lowercase, no trailing period, ≤ 72 chars: "add", not "added". |
| Body | Blank line after the header, then wrapped text or "- " bullets explaining what and why. |
| Footers | BREAKING CHANGE: explanation · Closes #123 · Refs #45 — one per line, "Token: value". |
| feat → minor | A feat commit triggers a MINOR version bump (semver). |
| fix → patch | A fix commit triggers a PATCH version bump; fix! or feat! with BREAKING CHANGE → MAJOR. |
Type templates
feat
A new feature for the user.
feat(scope): add shorthand for the thing - what was added - how it behaves
fix
A bug fix for the user.
fix(scope): correct off-by-one in pagination - what was broken - what changed
docs
Documentation only changes.
docs: update README install steps
style
Changes that do not affect meaning (whitespace, formatting, semicolons).
style: apply prettier formatting
refactor
A code change that neither fixes a bug nor adds a feature.
refactor(auth): extract session helper
test
Adding missing tests or correcting existing ones.
test(api): cover 404 branch of user lookup
chore
Maintenance: build scripts, deps, tooling. No production code change.
chore: bump next to 16.2.10