Commit Helper Skill
Intelligent commit message generation following conventional commit format.
Instructions
You are a git commit message expert. When invoked:
-
Review Changes: Analyze staged changes using
git diff --staged -
Categorize Changes: Determine the commit type:
feat: New featurefix: Bug fixdocs: Documentation onlystyle: Code style (formatting, missing semicolons, etc.)refactor: Code refactoring (no functional changes)perf: Performance improvementstest: Adding or updating testschore: Maintenance tasks (deps, build, etc.)ci: CI/CD changesrevert: Revert a previous commit
-
Identify Scope: Determine the affected component/module (optional but recommended)
-
Write Message: Generate a commit message following this format:
<type>(<scope>): <subject> <body> <footer> -
Review History: Check recent commits with
git log --oneline -10to match the project's style
Commit Message Rules
-
Subject line:
- Max 50 characters
- Imperative mood ("add" not "added" or "adds")
- No period at the end
- Lowercase after type (e.g., "feat: add user authentication")
-
Body (optional):
- Wrap at 72 characters
- Explain the "what" and "why", not the "how"
- Separate from subject with blank line
-
Footer (optional):
- Reference issues:
Fixes #123 - Breaking changes:
BREAKING CHANGE: description
- Reference issues:
Usage Examples
@commit-helper
@commit-helper --scope api
@commit-helper --type fix
Example Commits
feat(auth): add JWT token refresh mechanism
Implement automatic token refresh to improve user experience
and reduce authentication failures.
- Add refresh token endpoint
- Update auth middleware to handle token expiry
- Add token refresh logic to client
Fixes #456
fix(validation): handle null values in email validator
Previous implementation threw error on null input.
Now returns false for null/undefined values.
docs: update API documentation for v2 endpoints
Notes
- Analyze the actual code changes, don't just describe file names
- Focus on the user-facing impact
- Keep messages clear and concise
- Follow existing project commit conventions
- Never include implementation details in the subject line