Git Commit

Git Commit Message Generation

This skill assists in creating git commit messages that adhere to the Conventional Commits specification.

Instructions

When you are asked to create a commit message or commit changes, follow these steps:

1. Analyze and stage changes: Identify the changes that need to be committed. If they are not yet staged, stage them using git add <files> or git add ..
2. Determine the type: Use one of the following types:
   • feat: A new feature
   • fix: A bug fix
   • docs: Documentation only changes
   • style: Changes that do not affect the meaning of the code (white-space, formatting, etc)
   • refactor: A code change that neither fixes a bug nor adds a feature
   • perf: A code change that improves performance
   • test: Adding missing tests or correcting existing tests
   • build: Changes that affect the build system or external dependencies
   • ci: Changes to our CI configuration files and scripts
   • chore: Other changes that don't modify src or test files
   • revert: Reverts a previous commit
3. Determine the scope: (Optional but recommended) The specific module, directory, or component changed (e.g., acme, nginx, readme).
4. Write the description:
   • Must be in Chinese (Simplified).
   • Must be concise and descriptive.
   • Do not end with a period.
5. Format: Combine them as <type>(<scope>): <description>.
6. Execute the commit: Run the command git commit -m "<type>(<scope>): <description>" to commit the changes.

Examples

Example 1:

• Input: Added a new configuration file for Adminer.
• Command: git commit -m "feat(adminer): 添加 compose 配置文件"

Example 2:

• Input: Fixed a date formatting bug in utils.
• Command: git commit -m "fix(utils): 修复日期格式化错误"

Example 3:

• Input: Updated the README file.
• Command: git commit -m "docs(README): 更新项目说明"

Example 4:

• Input: Upgraded dependency packages.
• Command: git commit -m "chore(deps): 升级依赖包"

Converted and distributed by TomeVault — claim your Tome and manage your conversions.