commit-messager
Write clear and concise commit messages that accurately describe the changes made in the codebase
When & Why to Use This Skill
The commit-messager skill is a specialized utility designed to automate the creation of professional, standardized Git commit messages. By analyzing staged changes and branch names, it generates clear, concise, and developer-friendly documentation that follows Conventional Commits standards (feat, fix, docs, etc.). This tool enhances codebase maintainability and streamlines the version control workflow for individual developers and engineering teams.
Use Cases
- Standardizing Team Commits: Ensure all team members follow the same Conventional Commits format and present-tense imperative mood for a clean and readable project history.
- Automated Task Linking: Automatically extract task IDs or ticket numbers from Git branch names and append them to commit messages to maintain traceability with project management tools.
- Summarizing Complex Diffs: Generate structured bullet points for significant logic changes, providing immediate context for reviewers without them needing to parse the entire diff manually.
- Improving Documentation Quality: Create high-quality, descriptive commit messages that serve as a reliable audit trail for future debugging and refactoring sessions.
| name | commit-messager |
|---|---|
| description | Write clear and concise commit messages that accurately describe the changes made in the codebase |
| allowed-tools | Bash(git branch:*), Bash(git diff:*) |
Tools
- Current git diff (staged): !
git diff --cached - Current branch: !
git branch --show-current
Your Task
Your role as a front-end developer. Put the $ARGUMENTS [context] as additional context to write clear and concise commit message when provided. Only output the commit message as code canvas so I can copy them, don't execute git commit message command.
Custom Instructions
- Analyze the staged changes in the codebase
- Commit message must follow these rules:
- Start with a type (feat/fix/docs/chore/refactor) according your judgement of the changes.
- Write clear, concise, and developer-friendly commit messages under 160 characters that accurately describe the code changes in the current staged files only.
- Use present tense and imperative mood. Explain what and why, not how.
- Add task number with "#" character based on current branch name at the end of the commit message title. eg: : #
- Add a few bullet points explaining the detailed change if the commit message title isn't enough to explain the changes. Keep in mind that bullet points aren't necessary when the commit message title is already clear and self-explanatory describing the changes. DON'T WRITE UNNECESSARY POINT. The explanation for each point must be unique one each other; there should be no repetition of information or context.
- DON'T ADD YOUR SIGNATURE at the end of the commit message.tical logic code changes, add minimum 2 and maximum 5 detailed bullet points explaining the change. The explanation for each point must be different from one another; there should be no repetition of information.