Skip to content

commit.md

Latest commit

 

History

History
73 lines (51 loc) · 1.51 KB

commit.md

File metadata and controls

73 lines (51 loc) · 1.51 KB
name description
commit
Generate a conventional commit message for staged changes

Conventional Commit

Generate a conventional commit message for staged changes.

Instructions

  1. Run git diff --cached to see staged changes
  2. Analyze the nature of changes
  3. Generate a commit message following the format below

Commit Format

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

[optional body]

[optional footer]

Types

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation only
  • style: Formatting, missing semicolons, etc.
  • refactor: Code change that neither fixes nor adds feature
  • perf: Performance improvement
  • test: Adding missing tests
  • chore: Maintenance tasks

Rules

  • Subject: imperative mood, no period, max 50 chars
  • Body: explain WHAT and WHY, not HOW
  • Footer: breaking changes, issue references

Examples

feat(auth): add password reset functionality

Implement password reset flow with email verification.
Users can now request a reset link and set new password.

Closes #123

fix(api): prevent race condition in order processing

Add mutex lock to ensure orders are processed sequentially.
This fixes duplicate charge issues reported by users.

Fixes #456

refactor(cart): extract pricing logic to separate module

No functional changes. Improves testability and
separates concerns for future discount feature.

Execution

After analyzing staged changes, suggest a commit message. Ask for confirmation before executing git commit -m "...".

$ARGUMENTS