Commit Message Generator

Generate well-structured commit messages following the Conventional Commits specification.

Format

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

<body>

<footer>

Types

Workflow

1. Run git diff --staged to see changes
2. Identify the primary change type
3. Determine scope from affected files/modules
4. Write subject (imperative, no period, max 50 chars)
5. Add body if changes need explanation

Examples

Example 1: Simple feature

Staged changes: Added new login button component

Commit message:
feat(auth): add login button component

Example 2: Bug fix with context

Staged changes: Fixed null pointer in user service when email is empty

Commit message:
fix(user): handle empty email in validation

Previously, the service would crash when email field was null.
Added null check before validation logic.

Example 3: Breaking change

Staged changes: Changed API response format from array to object

Commit message:
feat(api)!: change response format to object structure

BREAKING CHANGE: API now returns { data: [], meta: {} }
instead of plain array. Update client code accordingly.

Rules

• Subject line: imperative mood ("add" not "added")
• Subject line: max 50 characters
• Body: wrap at 72 characters
• Use ! after type/scope for breaking changes
• Reference issues in footer: Fixes #123