Generate clear, conventional commit messages from git diffs. Use when writing commit messages, reviewing staged changes, or preparing releases.
Generate consistent, informative commit messages following the Conventional Commits specification.
git commit commandgit diff --staged to see what's being committed<type>(<scope>): <description>
[optional body]
[optional footer(s)]
| Type | Description | Example |
|---|---|---|
feat |
New feature | feat(auth): add OAuth2 login |
fix |
Bug fix | fix(api): handle null response |
docs |
Documentation only | docs(readme): add setup instructions |
style |
Formatting, no code change | style: fix indentation |
refactor |
Code change, no new feature/fix | refactor(db): extract query builder |
perf |
Performance improvement | perf(search): add result caching |
test |
Adding/fixing tests | test(auth): add login unit tests |
build |
Build system changes | build: update webpack config |
ci |
CI configuration | ci: add GitHub Actions workflow |
chore |
Maintenance tasks | chore(deps): update dependencies |
revert |
Revert previous commit | revert: feat(auth): add OAuth2 |
The scope should be a noun describing the section of the codebase:
auth, api, db, ui, configsearch, checkout, dashboardBREAKING CHANGE: for breaking changesFixes #123 to close issuesRefs #456 to reference without closingfeat(search): add fuzzy matching support
Implement Levenshtein distance algorithm for typo tolerance
in search queries. Configurable via FUZZY_THRESHOLD env var.
fix(cart): prevent duplicate items on rapid clicks
Add debounce to add-to-cart button and check for existing
items before insertion.
Fixes #234
feat(api)!: change response format to JSON:API
BREAKING CHANGE: API responses now follow JSON:API spec.
All clients need to update their parsers.
- Wrap data in `data` object
- Move metadata to `meta` object
- Add `links` for pagination
refactor(auth): consolidate authentication logic
- Extract JWT handling to dedicated service
- Move session management from controller to middleware
- Add refresh token rotation
This prepares for the upcoming OAuth2 integration.
When generating a commit message: