Git Conventional Commits Skill

This skill enables the AI to generate high-quality, standardized git commit messages based on the current staged changes. It adheres to the Conventional Commits specification and supports Gitmoji.

Workflow

When triggered, follow these steps:

1. Check Status:
   • Run git status to check for staged changes.
   • If no changes are staged but modified files exist, ask the user if they want to stage all changes (git add .) or specific files.
   • If no changes exist, inform the user.
2. Analyze Diff:
   • Run git diff --cached to get the content of the staged changes.
   • Analyze the diff to understand the intent and scope of the changes.
   • Identify the primary type (feat, fix, etc.) using references/types.md.
   • Identify the scope (e.g., module name, file name).
   • Select a relevant emoji using references/emojis.md.
3. Determine Language:
   • Check if the user explicitly requested a specific language (e.g., "in Chinese", "用中文").
   • If not specified, detect the language of the user's prompt.
   • Set the target language for the commit message (Subject, Body, Footer) to match the user's language or request.
   • Note: The <type> (feat, fix, etc.) should always remain in English as per Conventional Commits standard.
4. Generate Message:
   • Construct the commit message using the following format:

     <type>(<scope>): <emoji> <subject>
     
     <body>
     
     <footer>

   • Header:
     • <type>: Must be one of the types in references/types.md.
     • (<scope>): Optional but recommended.
     • <emoji>: Select from references/emojis.md.
     • <subject>: Imperative, present tense. MUST be in the determined target language.
   • Body (Optional):
     • Use for non-trivial changes.
     • Use bullet points (- ) for multiple changes.
     • Explain what and why. MUST be in the determined target language.
   • Footer (Optional):
     • Reference issues (e.g., Closes #123).
     • Mention breaking changes (BREAKING CHANGE: ...). Description MUST be in the determined target language.
5. Review & Output:
   • Present the generated commit message to the user for review.
   • (Optional) You can run python scripts/validate.py "<message>" to verify the format before presenting.
   • Ask the user if they want to proceed with the commit (git commit -m "...").

Examples

Feature with Scope and Body

Input: Added a new login function in auth.py and updated the user model. Output:

feat(auth): ✨ Add user login functionality

- Implemented `login` function in `auth.py`
- Updated `User` model to support session tokens

Bug Fix

Input: Fixed a crash when input is null in parser.js. Output:

fix(parser): 🐛 Handle null input in parser

- Added check for null input to prevent runtime error
- Added unit test for null case
Closes #42

Documentation

Input: Updated README with installation instructions. Output:

docs(readme): 📝 Update installation instructions

Chinese Example

Input: 用户请求生成中文提交信息，或者用户用中文描述了更改：在 auth.py 中添加了登录功能。 Output:

feat(auth): ✨ 添加用户登录功能

- 在 `auth.py` 中实现 `login` 函数
- 更新 `User` 模型以支持会话令牌

References

• Commit Types
• Gitmojis