Skip to content

git-commit-msg.md

Latest commit

 

History

History
212 lines (175 loc) · 7.43 KB

git-commit-msg.md

File metadata and controls

212 lines (175 loc) · 7.43 KB
Raw

Git Commit Message Template

⚠️ CRITICAL: DO NOT OVERWRITE THIS FILE

THIS FILE IS A TEMPLATE/INSTRUCTIONS FILE - NEVER OVERWRITE IT WITH ACTUAL COMMIT MESSAGES

  • This file contains instructions and examples for generating commit messages
  • DO NOT write actual commit messages to this file
  • DO NOT replace the contents of this file with generated commit messages
  • When generating commit messages, output them to the terminal or use them directly in git commands
  • This file should remain as a reference template only
  • If you need to save a commit message, use a temporary file or pass it directly to git

Usage

Supply this file to the AI to generate a git commit message based on changes since the last commit. Messages use emoji bullet points for clarity and visual appeal.

Format

The AI should:

  1. Analyze the git diff to understand changes
  2. Create a concise commit message under 140 characters
  3. Use conventional commit format: type: description
  4. Focus on the most significant changes
  5. Use commas instead of dashes between items (per user preference)
  6. For single type changes: Use the format: type:\n followed by emoji bullet points
  7. For multiple type changes: Use separate sections: type1:\n followed by emoji bullets, then type2:\n followed by emoji bullets, etc.
  8. Each change gets its own line with an appropriate emoji
  9. Start with the commit type(s) followed by a colon
  10. Add a newline, then list changes as emoji bullets
  11. Choose emojis that match the type of change
  12. Keep each bullet point concise and descriptive
  13. Prioritize the most impactful changes first
  14. Automatically stage, commit, and push unless specifically instructed otherwise

Commit Types

  • feat: New features
  • fix: Bug fixes
  • refactor: Code refactoring
  • docs: Documentation changes
  • style: Code style changes (formatting, etc.)
  • test: Test additions or changes
  • chore: Maintenance tasks
  • perf: Performance improvements
  • ci: CI/CD changes
  • build: Build system changes

Common Emojis

  • 🔀 Routing, navigation, parallel/interception routes
  • 🎯 Features, functionality
  • 📝 Documentation, structure, updates
  • 🔧 Configuration, setup
  • ⚡ Performance, optimization
  • 🐛 Bug fixes
  • 🎨 UI, styling, components
  • 📛 Badges, metadata
  • 🔐 Auth, security
  • 📦 Dependencies, packages
  • ♻️ Refactoring, code quality
  • 🗑️ Removal, deletion
  • ✨ New functionality

Examples

  • refactor: remove duplicate metadata titles, update deps, restructure auth routes
  • feat: add user authentication, implement password reset flow
  • fix: resolve type errors, update component props, improve error handling

Small Changes (1-5 files)

docs:
📛 Added tech stack badges with package versions
📝 Updated project structure documentation

fix:
🐛 Resolved session type inference errors
🔧 Updated auth helper types

Multiple Types (Mixed Changes)

docs:
📝 Updated README with current codebase structure
📁 Refreshed project structure to reflect password feature module

refactor:
♻️ Moved password management to dedicated feature module
🔧 Enhanced error handling with Better Auth APIError

feat:
✨ Added password changed email notification system

fix:
🐛 Fixed FieldError component to prevent password exposure

style:
🎨 Improved CSS animations with modern transform properties

Medium Changes (6-15 files)

feat:
✨ Implemented password reset flow
📧 Added email verification with React Email
🔐 Created forgot-password action and form

Large Changes (16-30 files)

refactor:
♻️ Converted all components to arrow functions
🎨 Migrated AlertDialog to Dialog component
🔀 Created shared auth content components
🎯 Preserved state on interception route refresh
📦 Updated dependencies

Extensive Changes (30+ files)

refactor:
♻️ Converted 35+ components from function declarations to arrow functions
🔀 Implemented interception routes for auth modals with state preservation
🎯 Created shared page content components (sign-in, sign-up, forgot-password)
🎨 Applied 16 canonical CSS class optimizations (data-disabled, data-inset, min-inline-32)
🔧 Configured Biome useArrowFunction linter rule in complexity group
🗑️ Removed AlertDialog component in favor of Dialog
📦 Updated project dependencies (bun.lock, package.json)

Instructions for AI

⚠️ IMPORTANT: DO NOT OVERWRITE THIS FILE

  • This is a template/instructions file - never write actual commit messages to it
  • Generate commit messages in memory or output to terminal, then use them directly in git commands
  • Keep this file as a reference template only

Steps to Generate Commit Messages

  1. Check git status:

    • Use GitKraken MCP git_status to check current state, OR
    • Run git diff to see unstaged changes
    • Run git diff --cached to see staged changes
    • Run git diff --stat to see change summary

  2. Analyze changes:

    • Count files changed and lines modified
    • Categorize changes by type (feat, fix, refactor, etc.)
    • Identify the most impactful changes

  3. Generate commit message:

    • Start with commit type and colon (e.g., feat:, refactor:, docs:)
    • Add a newline
    • List changes as emoji bullet points
    • Each change on its own line
    • Use relevant emojis from the common emojis list
    • Order by importance (most impactful first)
    • Keep bullet points concise and descriptive
    • ESCAPE SPECIAL CHARACTERS: Use \' for apostrophes, \" for quotes, \\ for backslashes
    • Scale based on change size:
      • Small (1-5 files): 2-3 bullet points
      • Medium (6-15 files): 3-4 bullet points
      • Large (16-30 files): 5-7 bullet points
      • Extensive (30+ files): 7-10 bullet points

  4. Execute git operations (unless explicitly instructed otherwise):

    • Use GitKraken MCP git_add_or_commit with action="add" to stage changes, OR
    • Stage all changes: git add .
    • Use GitKraken MCP git_add_or_commit with action="commit" to commit with generated message
    • Use GitKraken MCP git_push to push to remote, OR
    • Push to origin: git push origin main
    • Skip git operations only if explicitly instructed (e.g., "just generate the message", "don't commit", etc.)

Character Escaping Rules

When generating commit messages, escape these characters to prevent shell interpretation issues:

  • Apostrophes: Valibot's → Valibot\'s
  • Double quotes: "feature" → \"feature\"
  • Backslashes: \n → \\n
  • Dollar signs: $variable → \$variable
  • Backticks: `code` → \`code\`
  • Parentheses: (important) → \(important\)
  • Brackets: [array] → \[array\]
  • Braces: {object} → \{object\}
  • Pipes: a|b → a\|b
  • Semicolons: ; command → \; command
  • Ampersands: a&b → a\&b
  • Less than: <tag> → \<tag\>
  • Greater than: >output → \>output
  • Question marks: ?query → \?query
  • Exclamation marks: !important → \!important
  • Hash symbols: #comment → \#comment
  • At symbols: @user → \@user
  • Percent signs: %complete → \%complete
  • Tildes: ~home → \~home
  • Caret: ^version → \^version
  • Plus signs: +feature → \+feature
  • Equals signs: =value → \=value
  • Commas: a,b → a\,b
  • Periods: .file → \.file
  • Colons: :value → \:value
  • Slashes: /path → \/path