Work Commit

Commit Message Generation

Conventional Commits Format

type(scope): short description (< 50 characters)

[optional body - details on the "what" and "why"]

[optional footer - issue references, breaking changes]

Instructions

1. Analyze the changes

# View modified files
git status --short

# View detailed diff
git diff --staged

# If nothing is staged, view non-staged changes
git diff

2. Determine the type

3. Identify the scope

The scope indicates the part of the code affected:

• Module name: auth, api, ui
• Component name: button, modal
• Feature: login, checkout

4. Write the description

• Imperative present: "add" not "added" or "adds"
• Lowercase: no capital at the start
• No trailing period
• < 50 characters

5. Commit

git add [files]
git commit -m "type(scope): description"

Or with body:

git commit -m "type(scope): description

- Detail 1
- Detail 2

Refs: #123"

Rules

• ONE commit = ONE logical change
• Clear message for someone unfamiliar with the context
• Explain the WHY, not the HOW (the code shows the how)
• Reference issues if applicable

Examples

Good messages

feat(auth): add OAuth2 login support
fix(api): handle null response from external service
refactor(utils): extract date formatting to separate module
test(cart): add unit tests for price calculation
docs(readme): update installation instructions

Bad messages

❌ "fix bug"                    → Too vague
❌ "Update code"                → Not informative
❌ "WIP"                        → Don't commit WIP
❌ "feat: Add new feature..."   → Redundant