AI Agent / 系统课时
整理 Git 变更
整理 Git 变更
本课把一组已完成的代码修改整理为可审查提交。你将按状态、统计、内容和校验四个层次检查差异,再选择性暂存文件、生成准确提交说明,并在提交前确认测试与暂存区一致。
学习目标
- 用 Git 命令分层检查工作区和暂存区
- 排除无关文件并组织单一目的的变更集
- 根据真实差异编写可验证的提交说明
先确认工作区范围
不要一开始就执行 git add .。先查看修改、删除和未跟踪文件,识别构建产物、临时日志或本地配置。
bash
git status --short
git diff --stat预期结果类似:
text
M README.md
M src/config.mjs
?? test/config.test.js
README.md | <N> +++++
src/config.mjs | <N> +++++---
2 files changed, <N> insertions(+), <N> deletions(-)<N> 随实际修改变化。未跟踪文件不会出现在普通 git diff --stat 中,因此必须同时查看 git status --short。
检查内容与空白错误
先看完整未暂存差异,再运行空白检查。对于大仓库,可按文件逐个查看,避免在长输出中漏掉意外改动。
bash
git diff
git diff --check预期结果:
text
<git diff 显示尚未暂存的逐行变化>
<git diff --check 无输出>git diff --check 无输出仅表示没有常见空白错误。它不会发现逻辑缺陷、敏感信息或错误配置,仍需人工阅读差异。
选择性暂存
只暂存属于当前任务的文件。若单个文件混合了多个目的,可用补丁模式逐块选择。
bash
git add README.md src/config.mjs test/config.test.js
git status --short预期结果:
text
M README.md
M src/config.mjs
A test/config.test.js状态字母出现在左列表示变化已进入暂存区。此时普通 git diff 可能为空,应改用 git diff --cached 审查即将提交的内容。
验证暂存区与测试
提交前再次检查暂存统计、完整差异和项目测试。下面以 npm 项目为例,实际项目应替换为仓库规定的命令。
bash
git diff --cached --stat
git diff --cached --check
npm test预期结果:
text
README.md | <N> +++++
src/config.mjs | <N> +++++---
test/config.test.js | <N> +++++++++
<N> files changed, <N> insertions(+), <N> deletions(-)
<git diff --cached --check 无输出>
<项目测试全部通过,退出码为 0>如果测试会修改快照或生成文件,测试后必须重新运行 git status --short,确认暂存区没有被悄悄改变。
编写提交说明
提交标题应描述这组差异完成的结果,而不是记录操作过程。可让 Codex根据 git diff --cached 生成候选说明,但必须逐项核对,不能声称修改了差异中不存在的内容。
text
fix(config): validate request timeout setting
- add a positive-integer guard for REQUEST_TIMEOUT_MS
- document the default value and usage example
- cover default, override, and invalid inputs这是提交说明片段,不是可执行命令。使用前应确认三条正文都能在暂存差异中找到证据。真正提交时运行:
bash
git commit -m "fix(config): validate request timeout setting"预期输出类似:
text
[<BRANCH> <COMMIT>] fix(config): validate request timeout setting
<N> files changed, <N> insertions(+), <N> deletions(-)<BRANCH>、<COMMIT> 和 <N> 为动态值。
按自己的节奏,确认真正理解。