全部文档开发实践
开发实践

Git 小步提交:让每一次改动都容易理解

提交不是备份按钮,而是给未来读者的一段上下文。让历史保持清晰,回滚和协作都会更轻松。

一个提交只表达一个意图

把修复登录校验和调整页面间距放进同一个提交,会让审查、回滚和定位问题都变得困难。提交前先看差异:

git status --short
git diff --check
git diff --stat

提交信息写结果

推荐使用动词开头,说明结果和范围:

fix(auth): reject expired session cookies
docs(deploy): add HTTPS renewal check

正文只在需要解释为什么时补充。实现细节通常已经在 diff 里,动机则不会。

提交前的三个问题

  1. 这个提交能否用一句话说清楚?
  2. 删除它,是否只会撤销一个行为?
  3. 别人能否从提交信息判断应该先看哪里?
— 本文完 —

把解决过的问题,变成可以复用的经验。

← 返回全部文档