Quick Commit

Quick Commit

Automatically generate clear, conventional commit messages from your staged changes.

When to Use

✅ Use this skill when:

• You've made changes and need a commit message
• You want to follow conventional commit format
• You're committing multiple related changes
• You want clear, searchable git history

❌ Do NOT use when:

• You need to split changes into multiple commits
• Your changes are too complex to summarize automatically

Prerequisites

• Git repository initialized
• Changes staged with git add

Quick Start

# Stage your changes
git add .

# Generate and commit
git commit -m "$(git diff --cached --stat | head -20)"

Instructions

Step 1: Analyze Staged Changes

# See what's staged
git diff --cached --stat
git diff --cached

Step 2: Identify Change Type

Step 3: Write the Message

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

Examples:

feat(auth): add JWT token refresh mechanism
fix(api): handle null response from user endpoint
docs(readme): update installation instructions
refactor(utils): extract validation logic to separate module

Step 4: Commit

git commit -m "feat(auth): add JWT token refresh mechanism"

Pitfalls

⚠️ Common Mistakes:

1. Too vague messages

Wrong: git commit -m "fix bug" Right: git commit -m "fix(auth): prevent token expiration during long sessions"

2. Committing too much

Problem: One commit with unrelated changes

Solution: Split into logical commits:

git add src/auth/
git commit -m "feat(auth): add password reset flow"

git add src/api/
git commit -m "feat(api): add password reset endpoint"

3. Wrong type prefix

Problem: Using feat for a bug fix

Solution: Be precise:

• New feature → feat:
• Fixing broken behavior → fix:
• Improving code structure → refactor:

Verification

After committing:

• Message is clear: Can someone understand the change from the message alone?

  git log -1 --oneline
  

• Scope is correct: Does the scope match the changed files?

  git diff HEAD~1 --stat
  

• Type is accurate: Does the type reflect the change nature?

Examples

Single File Change

# Modified: src/api/users.js
git add src/api/users.js
git commit -m "fix(api): handle missing user profile gracefully"

Multiple Related Files

# Modified: src/auth/login.js, src/auth/middleware.js, tests/auth.test.js
git add src/auth/ tests/auth.test.js
git commit -m "feat(auth): implement refresh token rotation"

Documentation Update

# Modified: README.md, docs/api.md
git add README.md docs/
git commit -m "docs: add API authentication guide"

Configuration Change

# Modified: .eslintrc.js, package.json
git add .eslintrc.js package.json
git commit -m "chore: upgrade ESLint to v9 and update rules"

Advanced: Auto-Generate Message

Use git to suggest a message:

# Show changes summary
git diff --cached --stat | tail -1

# Show changed function names
git diff --cached | grep "^+" | grep -E "(function|def |class |const )" | head -5

# Suggest message based on file types
echo "Changed files:"
git diff --cached --name-only | sed 's/.*\.//' | sort | uniq -c

References

• Conventional Commits
• How to Write a Git Commit Message
• Angular Commit Guidelines

Part of Awesome AI Agent Skills