commit-helper

Commit Message Helper

A skill for creating properly formatted Git commit messages following the Conventional Commits specification.

When This Skill Activates

This skill activates when you:

• Ask to commit changes
• Mention commit messages
• Request git commit formatting
• Say "commit" or "git commit"

Commit Message Format

<type>(<scope>): <subject>

<body>

<footer>

Types

Scope

The scope should indicate the area of the codebase affected:

• For frontend: components, hooks, store, styles, utils
• For backend: api, models, services, database, auth
• For devops: ci, deploy, docker
• Project-specific scopes are also acceptable

Guidelines

Subject Line

• Use imperative mood ("add feature" not "added feature" or "adds feature")
• No period at the end
• Maximum 50 characters
• Be specific and concise

Body

• Separate subject from body with a blank line
• Use the body to explain what and why, not how
• Wrap at 72 characters per line
• Mention any breaking changes

Footer

• Reference issues: Closes #123, Fixes #456, Refs #789
• Multiple issues: Closes #123, #456, #789
• Breaking changes: Start with BREAKING CHANGE: followed by description

Examples

Good Examples

feat(auth): add OAuth2 login support

Implement OAuth2 authentication flow to allow users to log in
with their Google or GitHub accounts.

This change adds:
- New OAuth2 middleware for handling callbacks
- Updated login UI with social login buttons
- User profile synchronization

Closes #123

Bad Examples

Breaking Changes

When introducing breaking changes, add BREAKING CHANGE: to the footer:

Workflow

When writing a commit message:

1. Review changes - Run git diff to understand what changed
2. Identify type - Determine the type of change
3. Identify scope - Determine which area is affected
4. Write subject - Create a clear, concise subject line
5. Write body - Explain what and why (if needed)
6. Add footer - Reference issues or note breaking changes

Validation

Use the validation script to check commit message format:

Reference Documents

• See references/conventional-commits.md for full specification
• See references/examples.md for more examples
• See references/scopes.md for recommended scope naming