commit-work

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Chinese

Make commits that are easy to review and safe to ship:

创建易于审核且可安全发布的提交记录：

Single commit or multiple commits? Default to multiple small commits when there are unrelated changes.
Any extra rules: max subject length, required scopes.

Inspect the working tree
- ```
git status
```
  and
```
git diff
```
  (unstaged)
- If many changes:
```
git diff --stat
```
Decide commit boundaries (split if needed)
- Split by: feature vs refactor, backend vs frontend, formatting vs logic, tests vs prod code, dependency bumps vs behavior changes
- If you cannot describe the commit cleanly in one sentence, it's too big — split further
Stage only what belongs in the next commit
- Use
```
git add -p
```
  for mixed changes in one file
- To unstage:
```
git restore --staged -p
```
  or
```
git restore --staged <path>
```
Review what will be committed
- ```
git diff --cached
```
- Verify: no secrets/tokens, no debug logging, no unrelated formatting churn
Describe the staged change in 1-2 sentences before writing the message
- "What changed?" + "Why?"
- If you cannot describe it cleanly, the commit is probably too big or mixed — go back to step 2
Write the commit message (see format below)
- Prefer
```
git commit -v
```
  for multi-line messages
Verify — run the repo's fastest relevant check (lint, unit tests, or build)
Repeat for the next commit until the working tree is clean

检查工作区
- 执行
```
git status
```
  和
```
git diff
```
  （查看未暂存变更）
- 若变更较多：执行
```
git diff --stat
```
确定提交边界（必要时拆分）
- 拆分依据：功能新增 vs 代码重构、后端 vs 前端、格式调整 vs 逻辑修改、测试代码 vs 生产代码、依赖更新 vs 行为变更
- 若无法用一句话清晰描述提交内容，说明提交范围过大——需进一步拆分
暂存仅属于下一次提交的内容
- 若单个文件存在混合变更，使用
```
git add -p
```
- 取消暂存：执行
```
git restore --staged -p
```
  或
```
git restore --staged <path>
```
审核即将提交的内容
- 执行
```
git diff --cached
```
- 验证：无密钥/令牌、无调试日志、无无关格式变更
撰写提交信息前，用1-2句话描述暂存的变更
- 包含“变更了什么？” + “为什么变更？”
- 若无法清晰描述，说明提交可能范围过大或内容混杂——回到步骤2
撰写提交信息（格式见下文）
- 多行信息优先使用
```
git commit -v
```
验证——执行仓库中最相关的快速检查（代码检查、单元测试或构建）
重复上述步骤，直到工作区无待处理变更

Format:

type(context): description

格式：

type(context): description

The final commit message(s)
A short summary per commit (what/why)
The commands used to stage/review (at minimum:
```
git diff --cached
```
, plus any tests run)