← 返回笔记列表
Tools / Git

用小提交表达一次修改

提交记录也是一种写作。它把当前发生的变化,留给未来的维护者阅读。

从查看差异开始

准备提交时,先确认自己修改了哪些文件,再阅读具体差异。这样能发现顺手改动的内容,也能避免把无关文件带进同一次提交。

git status --short
git diff

默认情况下,git diff 展示工作区中尚未暂存的差异。加入暂存区之后,可以用 git diff --staged 检查将要提交的内容。

按目的组织内容

一次提交最好能用一个明确的目的解释。修正文案和调整页面布局可以分别提交;如果几处修改共同完成同一个行为变化,放在一起也很自然。

“小”不是机械地限制行数,而是让阅读者能够理解这次变化的边界。不要为了拆分而制造无法单独理解的中间状态。

提交信息写发生了什么

比起“更新”或“修改了一些东西”,说明具体结果更有价值。例如:

修正文章列表中失效的链接

统一目录页与文章页的文件名,补上返回列表的入口。

标题表达主要变化,必要时在正文补充原因和验证方式。清楚通常比套用复杂格式更重要。

提交之前再看一遍

让每一次提交都能被读懂,历史记录才会真正有用。