git-commit

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Chinese

This skill provides instructions for performing atomic, well-structured Git commits following the Conventional Commits specification.

本技能提供遵循Conventional Commits规范执行原子化、结构清晰的Git提交的指导说明。

Identify Modified Files: Run
```
git status --short
```
to see all staged and unstaged changes.
Respect Ignore Rules: Do NOT include files that the user has explicitly requested to ignore or that match
```
.gitignore
```
patterns.
Group by Scope: Group modified files by their logical "scope" (e.g., a specific module, feature, or layer like
```
data
```
,
```
domain
```
,
```
ui
```
).

识别修改文件：运行
```
git status --short
```
查看所有已暂存和未暂存的变更。
遵守忽略规则：不要包含用户明确要求忽略或者匹配
```
.gitignore
```
规则的文件。
按范围分组：按照逻辑“范围”对修改的文件分组（例如特定模块、功能，或者
```
data
```
、
```
domain
```
、
```
ui
```
这类层级）。

Feature Branches: ALWAYS create descriptive feature branches from
```
main
```
(e.g.,
```
feat/login-logic
```
).
Merge Flow: Merge back into
```
main
```
only after passing all quality checks and PR approval.

Conventional Commits: Each commit MUST follow the pattern:
```
<type>(<scope>): <message>
```
.
- Types:
```
feat
```
  ,
```
fix
```
  ,
```
docs
```
  ,
```
style
```
  ,
```
refactor
```
  ,
```
perf
```
  ,
```
test
```
  ,
```
build
```
  ,
```
ci
```
  ,
```
chore
```
  ,
```
revert
```
  .
- Scope: The module or area being changed (e.g.,
```
auth
```
  ,
```
api
```
  ).
- Message: A concise description in imperative mood.
Sub-messages (Commit Body):
- ALWAYS include a detailed body if the change involves logic, breaking changes, or multiple steps.
- Explain the "What", "Why", and "How" of the change.
- Use blank lines to separate the subject from the body.

Conventional Commits：每次提交必须遵循以下格式：
```
<type>(<scope>): <message>
```
。
- 类型：
```
feat
```
  、
```
fix
```
  、
```
docs
```
  、
```
style
```
  、
```
refactor
```
  、
```
perf
```
  、
```
test
```
  、
```
build
```
  、
```
ci
```
  、
```
chore
```
  、
```
revert
```
  。
- 范围：被修改的模块或领域（例如
```
auth
```
  、
```
api
```
  ）。
- 信息：用祈使语气编写的简洁描述。
子信息（提交正文）：
- 如果变更涉及逻辑、破坏性改动或多步操作，必须包含详细的正文。
- 说明变更的“内容”、“原因”和“实现方式”。
- 使用空行分隔提交主题和正文。

Step 1: Group files by scope.
Step 2: For each group:
- Stage the files.
- Generate the conventional commit message (subject + body).
- Execute:
  bash
```
git commit -m "<subject>" -m "<body>"
```
Step 3: Verify history (
```
git log -n 5
```
).

步骤1：按范围对文件分组。
步骤2：对每个分组：
- 暂存文件。
- 生成符合Conventional Commits规范的提交信息（主题+正文）。
- 执行：
  bash
```
git commit -m "<subject>" -m "<body>"
```
步骤3：验证提交历史（
```
git log -n 5
```
）。