| name | smart-commit |
| description | Create clean Conventional Commits: inspect the diff, group related changes, run quality checks, and write type(scope) messages. Use when committing work, or when the user runs /smart-commit or asks to commit changes. |
| user-invocable | true |
Smart Commit
Create a high-quality commit for current changes.
Execution
- Inventory changes: run
git status and git diff (plus git diff --staged for already-staged work) to see everything that changed.
- Group related changes into logical commits — list the files that belong to each group so one commit maps to one concern.
- Run available quality gates (test suite, linter, formatter) if the project configures them, and fix failures before committing.
- Stage each group in turn with
git add <files>.
- Craft a Conventional Commits message —
type(scope): description, with a body that explains why the change was made.
- Commit the staged group.
- Confirm the result with
git log --oneline -n (choose n to cover the commits you just made).
Repeat steps 4-6 for each group so unrelated changes land in separate commits. The format and type reference below is your guide for steps 5-6.
Pre-Commit Checklist
Scope Check
Quality Check
Commit Message Format
<type>(<scope>): <description>
<body>
<footer>
Type (Required)
| Type | Use When |
|---|
feat | New feature (user-visible) |
fix | Bug fix |
docs | Documentation only |
test | Adding/updating tests |
refactor | Code restructure (no behavior change) |
style | Formatting (no logic change) |
chore | Maintenance, dependencies |
perf | Performance improvement |
Scope (Optional)
Module, component, or file affected:
feat(auth): add login endpointfix(api): handle null responsedocs(readme): update installation steps
Description (Required)
- 50 characters or less
- Present tense, imperative mood
- Lowercase first letter
- No period at end
- Describe WHAT, not HOW
Examples
Feature
feat(user): add email verification
Implement email verification flow for new user registration.
Users must verify email before accessing protected features.
Closes #42
Bug Fix
fix(api): handle null response in user endpoint
Previously threw uncaught exception when user not found.
Now returns 404 with proper error message.
Fixes #67
Commit Checklist
Before committing:
