name: commit-helper
description: Generates clear, conventional commit messages. Use when committing changes, writing commit messages, or following conventional commits format.
license: MIT
metadata:
author: thesimpleapp
version: "1.0"

Commit Helper

Generate commit messages following the Conventional Commits specification.

Format

<type>(<scope>): <description>

[optional body]

[optional footer]

Types

Rules

1. Subject line: Max 50 characters, imperative mood ("Add" not "Added")
2. Scope: Optional, indicates area affected (e.g., auth, api, ui)
3. Body: Explain what and why, not how. Wrap at 72 characters.
4. Footer: Reference issues, breaking changes

Examples

Simple feature:

feat(auth): add password reset flow

Bug fix with context:

fix(api): handle null response from payment gateway

The payment API occasionally returns null instead of an error object.
Added null check and proper error handling.

Fixes #123

Breaking change:

refactor(api)!: change user endpoint response format

BREAKING CHANGE: User endpoint now returns nested address object
instead of flat fields. Update all clients to use user.address.city
instead of user.city.

Process

1. Analyze staged changes with git diff --staged
2. Identify the primary type of change
3. Determine scope from affected files/modules
4. Write concise, meaningful description
5. Add body for non-obvious changes
6. Reference related issues