版本控制与协作 / 系统课时
分批暂存不同修改
分批暂存不同修改
学习目标
完成本课后,你将能够:
- 将无关修改拆分为多个提交
- 按路径选择暂存内容
- 理解逻辑提交对审查和回退的价值
问题背景或应用场景
真实开发中经常同时改动代码、测试和文档。如果把所有变化一次提交,代码评审难以聚焦,后续只回退其中一个目的也会变得困难。分批暂存可以在不丢失工作区修改的情况下,把当前工作整理成多个有意义的提交。
核心原理
暂存区允许开发者从工作区选择一个子集作为下一次提交。按文件暂存适合不同文件对应不同任务;同一文件包含多个逻辑修改时,可以使用 git add -p 按补丁块选择。第一次提交完成后,未暂存内容仍保留在工作区,可继续组成下一次提交。
提交边界应围绕可独立理解、可独立验证和可独立回退的目的。不要为了追求极小提交而拆开必须同时存在才能构建的修改,也不要把格式化、重命名和业务逻辑混在一个难以审查的大提交中。
基础用法
先使用 git status --short 列出全部变化,再选择与当前目的相关的路径执行 git add。使用 git diff --staged 确认内容后提交;随后重新查看状态,处理剩余修改。需要按块选择时,交互提示中的 y 表示暂存当前块,n 表示跳过,s 尝试拆分补丁块。
完整可运行示例
以下命令使用 Bash 语法,并在独立测试目录中执行。示例会设置仓库级身份,不会修改正式项目;提交哈希、默认分支名和绝对路径等动态值以占位符表示,实际输出可能不同。
bash
rm -rf git-split-commit-demo
mkdir git-split-commit-demo
cd git-split-commit-demo
git init -q
git config user.name "Anystack Student"
git config user.email "student@example.com"
printf "print('v1')\n" > app.py
printf "# Demo\n" > README.md
git add .
git commit -q -m "chore: create project"
printf "print('v2')\n" > app.py
printf "\n## Run\npython app.py\n" >> README.md
git add app.py
git commit -q -m "feat: update application output"
git add README.md
git commit -q -m "docs: add run instructions"
git log --oneline --reverse预期输出
text
<COMMIT_ID_1> chore: create project
<COMMIT_ID_2> feat: update application output
<COMMIT_ID_3> docs: add run instructionsTips
- 先决定提交目的,再选择文件,而不是先全部暂存再思考。
- 每次提交后运行最小验证,确保该提交本身处于可理解状态。
- 交互暂存前可备份重要未提交工作,避免误操作造成混乱。
常见错误
1. 一个提交包含多个无关主题
- 错误表现:评审者无法快速判断每部分目的。
- 正确处理:按功能、测试、文档或重构目的拆分暂存和提交。
2. 拆分后中间提交不可运行
- 错误表现:代码依赖被拆到下一提交。
- 正确处理:调整边界,让必要的实现与对应测试或配置共同提交。
本课练习
1. 按文件拆分
- 任务目标:按文件拆分。
- 输入或初始条件:同时修改源码和 README。
- 实现要求:创建两个提交。
- 验收条件:日志显示两个明确主题,最终状态干净。
2. 按补丁块拆分
- 任务目标:按补丁块拆分。
- 输入或初始条件:同一文件修改两个相距较远的函数。
- 实现要求:使用
git add -p分别提交。 - 验收条件:每个提交只包含一个函数变化。
3. 评估提交边界
- 任务目标:评估提交边界。
- 输入或初始条件:设计一个涉及接口、测试和文档的功能。
- 实现要求:说明哪些内容应同提交、哪些可拆分。
- 验收条件:边界兼顾可运行性和可审查性。
按自己的节奏,确认真正理解。