generating-commit-messages
MANDATORY skill for ALL commits. Must be used EVERY TIME before creating any git commit. No exceptions.
When & Why to Use This Skill
This Claude skill automates the generation of professional, standardized Git commit messages by performing a deep analysis of staged code changes. It ensures every commit follows industry best practices—including the use of imperative mood, concise summaries, and detailed explanations of the rationale behind changes—while strictly adhering to project-specific formatting constraints and forbidden content rules.
Use Cases
- Standardizing Repository History: Enforce a consistent commit message format across a multi-developer team to improve long-term maintainability and readability of the version control history.
- Automated Change Analysis: Use the skill to automatically interpret complex 'git diff' outputs and generate meaningful descriptions that explain both 'what' was changed and 'why' it was necessary.
- Workflow Compliance: Integrate this mandatory step into the development lifecycle to ensure no code is committed without a high-quality, descriptive message that meets project documentation standards.
- Technical Documentation: Streamline the process of creating audit trails for security patches or refactoring tasks by generating detailed lists of affected components and context.
| name | generating-commit-messages |
|---|---|
| description | MANDATORY skill for ALL commits. Must be used EVERY TIME before creating any git commit. No exceptions. |
Generating Commit Messages
⚠️ CRITICAL REQUIREMENT ⚠️
THIS SKILL MUST BE USED FOR EVERY SINGLE COMMIT
The CLAUDE.md file explicitly states: "Before committing changes, ALWAYS use the @.claude/skills/generating-commit-messages skill to generate commit messages"
Mandatory Process
BEFORE ANY git commit COMMAND:
- ALWAYS run
git diff --stagedfirst to see changes - ALWAYS analyze the staged changes thoroughly
- ALWAYS generate a commit message following the format below
- NEVER commit without following this process
Required Commit Message Format
Summary line (under 50 characters)
- Use present tense imperative mood
- Be specific and descriptive
Detailed description
- Explain WHAT was changed
- Explain WHY it was changed
- List affected components/files
- Include any important context
Best Practices
- Use clear, descriptive commit messages
- Use present tense ("Add feature" not "Added feature")
- Include the "why" not just the "what"
- Start summary with action verb (Add, Update, Fix, Remove, etc.)
- Be specific about what components/files are affected
FORBIDDEN Elements
- NEVER include "Generated with Claude Code"
- NEVER include "Co-Authored-By: Claude noreply@anthropic.com"
- NEVER use generic messages like "Update files" or "Fix issues"
Example Good Commit Message
Refactor authentication system for better security
Replace deprecated JWT library with more secure alternative
Add input validation for user credentials
Update authentication middleware to handle edge cases
Fix memory leak in session management
This change improves security posture and resolves crashes reported in production when handling malformed requests.
Reminder
If you find yourself about to run git commit without having followed this skill, STOP immediately and use this skill first.
Version History
- v1.1.0 (2025-11-18): Enhanced with mandatory usage requirements and better formatting
- v1.0.0 (2025-11-14): Initial release