git-commit-formatter

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Git Commit Formatter Skill

Git Commit Formatter Skill

When writing a git commit message, you MUST follow the Conventional Commits specification.
编写Git提交信息时,你必须遵循Conventional Commits规范。

Format

格式

<type>[optional scope]: <description>
<type>[可选范围]: <描述>

Allowed 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
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
  • feat:新增功能
  • fix:修复Bug
  • docs:仅修改文档
  • style:不影响代码含义的更改(如空白字符、格式调整等)
  • refactor:既不修复Bug也不新增功能的代码更改
  • perf:提升性能的代码更改
  • test:添加缺失的测试或修正现有测试
  • chore:对构建流程或辅助工具、库的更改(如文档生成工具)

Instructions

操作步骤

  1. Analyze the changes to determine the primary
    type
    .
  2. Identify the
    scope
    if applicable (e.g., specific component or file).
  3. Write a concise
    description
    in imperative mood (e.g., "add feature" not "added feature").
  4. If there are breaking changes, add a footer starting with
    BREAKING CHANGE:
    .
  1. 分析更改内容以确定主要的
    type
  2. 若适用,确定
    scope
    (例如特定组件或文件)。
  3. 使用祈使语气编写简洁的
    描述
    (例如:"add feature" 而非 "added feature")。
  4. 若存在破坏性更改,添加以
    BREAKING CHANGE:
    开头的页脚。

Example

示例

feat(auth): implement login with google
feat(auth): implement login with google