[译] Commit 提交指南
站长
· 阅读数 37
![[译] Commit 提交指南](https://static.blogweb.cn/article/6b766eb1acf443499a794ef9be4e6742.webp)
一份理解 commit 信息重要性以及如何写好它们的指导手册。
它可以帮你了解什么是 commit，为什么填写好的信息说明比较重要，以及提供最佳实践、计划和（重新）书写良好的 commit 历史的一些建议。
可参考的语言版本
什么是 “commit”？
简而言之，commit 就是你本地仓库中文件的一个快照。 和一些人的想法相反，git 不仅存储文件之间的差异，还存储所有文件的完整版本。 对于从一次提交到另一次提交之间未发生改变的文件，git 仅存储之前已存的同一份文件的链接。
下面的图片显示了 git 随着时间变化如何存储数据，其中每个『版本』都是一个 commit：
![[译] Commit 提交指南](https://static.blogweb.cn/article/035ec222270749b7a03793c2f79dd661.webp)
为什么 commit 信息很重要？
- 加快和简化代码审查
- 帮助理解代码变更
- 协助解释仅靠代码无法完全描述的『为什么』
- 帮助未来的维护者明白变更的原因以及如何变更，使故障排查和调试更容易
为了最大化这些好处，我们可以使用下一节描述的一些好的实践和标准。
好的实践
这些是从我的经验、网络文章和其他指南中收集的一些实践案例。如果您有其他实践(或有不同意见)，请尽管随时打开 Pull Request 并贡献您的意见。
使用祈使形式
# 好示例
Use InventoryBackendPool to retrieve inventory backend
# 坏示例
Used InventoryBackendPool to retrieve inventory backend
但为什么要使用祈使形式？
一个 Commit 信息描述了提到的变化实际做了什么，它的影响，而非做的内容。
这篇来自 Chris Beams 的优秀文章 给我们一个简单的句子，可以帮助我们以祈使形式来书写更好的 commit 信息：
If applied, this commit will <commit message>
示例：
# 好示例
If applied, this commit will use InventoryBackendPool to retrieve inventory backend
# 坏示例
If applied, this commit will used InventoryBackendPool to retrieve inventory backend
首字母大写
# 好示例
Add `use` method to Credit model
# 坏示例
add `use` method to Credit model
首字母需要大写的原因是遵守句子开头使用大写字母的语法规则。
这个实践的使用可能因人而异，团队间亦可能不同，甚至不同语言的人群间也会不同。 大写与否，一个重要的点是要保持标准一致并且遵守它。
尝试在不必查看源代码的情况下沟通变化内容
# 好示例
Add `use` method to Credit model
# 坏示例
Add `use` method
# 好示例
Increase left padding between textbox and layout frame
# 坏示例
Adjust css
很多场景中(例子：多次提交、多次变更和重构)这都有助于帮助代码审查者理解代码提交者当时的想法。
使用消息体来解释『为什么』、『是什么』、『怎么做』以及附加细节信息
# 好示例
修复了 InventoryBackend 子类的方法名
InventoryBackend 派生出的类没有
遵循基类接口
它之所以运行，是因为 cart 以错误的方式
调用了后端实现。
# 好示例
Cart 中对 credit 与 json 对象间做序列化和反序列化
基于两个主要原因将 Credit 实例转化成 dict：
- Pickle 依赖于类的文件路径
如果需要重构的话我们不想破坏任何东西
- Dict 和内建类型在默认情况下是可以通过 pickle 来序列化的
# 好示例
Add `use` method to Credit
从 namedtuple 变成 class
是因为我们需要使用新的值来设置属性（in_use_amount）
提交信息的主题和正文被一个空白行分割 附加的空白行被认为是提交信息正文的一部分。
类似 -，* 和 \ 的字符是用来提高可读性的元素。
避免通用消息或者没有任何上下文的消息
# 坏示例
Fix this
Fix stuff
It should work now
Change stuff
Adjust css
限制字符数量
推荐主题最多使用 50 个字符，消息体最多使用 72 个字符。
保持语言的一致性
对于项目所有者：选择一个语言并使用该语言书写所有的 commit 信息。理想情况下，它应该匹配代码注释、默认翻译区域（对于做了本地化的应用）等等。
对于项目贡献者：基于已有 commit 历史书写同样语言的 commit 信息。
# 好示例
ababab Add `use` method to Credit model
efefef Use InventoryBackendPool to retrieve inventory backend
bebebe Fix method name of InventoryBackend child classes
# 好示例（葡萄牙语示例）
ababab Adiciona o método `use` ao model Credit
efefef Usa o InventoryBackendPool para recuperar o backend de estoque
bebebe Corrige nome de método na classe InventoryBackend
# 坏示例（混合了英语和葡萄牙语）
ababab Usa o InventoryBackendPool para recuperar o backend de estoque
efefef Add `use` method to Credit model
cdcdcd Agora vai
模板
这是一个样板，由 Tim Pope 编写，出现在文章高级 Git 手册。
简化变更内容到 50 字符左右或者更少
如有必要，可提供更详细的说明文字。
将它包装成大约 72 个字符左右。
在某些情况下，第一行被视为 commit 的信息主题，余下文字被认为信息正文。
将摘要和正文分离开的空白行很有必要（除非你忽略了整个正文）；
不同的工具像 `log`、`shortlog`、`rebase`，
可能会变得混乱，如果你同时运行两个。
解释本次 commit 正在解决的问题。
专注于此次变更的原因，而非如何变更（代码会解释这点）。
此次变更是否有副作用或其他隐性后果？
这里就是解释它们的地方。
空白行之后有更进一步的段落。
- 也可以用要点符号。
- 通常使用连字符或者星号作为要点符号，
前面有一个空格，中间有空白行，
但是约定惯例各不相同。
如果你使用问题跟踪，在底部放置它们的引用，
像下面这样：
Resolves: #123
See also: #456, #789
Rebase 与 Merge
这节是 Atlassian 优秀教程中的一个 TL;DR，“Merge 与 Rebase”。
![[译] Commit 提交指南](https://static.blogweb.cn/article/d9c35973e07940a2ae94f77fe127aff3.webp)
Rebase
TL;DR: 把你的分支中的 commit 一个接一个地应用到 base 分支，生成一个新树。
![[译] Commit 提交指南](https://static.blogweb.cn/article/c167af60dc504519825409e1f0deda83.webp)
Merge
TL;DR: 使用两个分支间的差异，创建新的 commit，称作（适当地）merge 提交。
![[译] Commit 提交指南](https://static.blogweb.cn/article/cfd20671e2e64dd38eb1af96a245b30b.webp)
为什么有些人更倾向于 merge 而不是 rebase？
我尤其更倾向于 rebase 而不是 merge，理由包含：
- 它生成了一个『整洁的』提交历史，没有不必要的 merge commit。
- 所见即所得，举例，在一次代码审查中，所有的变更来自对应某种特殊化的标注的 commit，避免了来隐藏在 merge commit 中的变更。
- 更多的 merge 被提交者解决，并且每个 merge 变化对应着具备合适信息的 commit。
- 对 merge 类 commit 做挖掘和审核并不常见，因此避免这类操作可以确保所有的变更都归属于某个 commit。
何时做 squash？
“Squashing” 是处理一系列 commit 并将它们压缩为一个 commit 的过程。
它在多种情况下都有用，例子：
- 减少包含少量或者没有上下文的 commit（错误修正、格式化、遗忘的内容）
- 将某些合并应用时更合理的独立变更结合起来
- 重写正在进行中这类 commit
何时避免 rebase 和 squash？
避免在多人协作的公共 commit 或者共享分支中执行 rebase 和 squash。 rebase、squash 重写历史记录、覆盖已有 commit，在共享分支的 commit 中执行以上操作（例子，推送到远程仓库的 commit 或者来自其他分支的 commit）可能造成混淆，并且由于分歧的树干和冲突大家可能会丢失他们的变更（本地和远程的）。
有用的 git 命令
rebase -i
使用它来压制 commit，编辑信息，重写/删除/重新排序 commit，等等。
pick 002a7cc Improve description and update document title
pick 897f66d Add contributing section
pick e9549cf Add a section of Available languages
pick ec003aa Add "What is a commit" section"
pick bbe5361 Add source referencing as a point of help wanted
pick b71115e Add a section explaining the importance of commit messages
pick 669bf2b Add "Good practices" section
pick d8340d7 Add capitalization of first letter practice
pick 925f42b Add a practice to encourage good descriptions
pick be05171 Add a section showing good uses of message body
pick d115bb8 Add generic messages and column limit sections
pick 1693840 Add a section about language consistency
pick 80c5f47 Add commit message template
pick 8827962 Fix triple "m" typo
pick 9b81c72 Add "Rebase vs Merge" section
# Rebase 9e6dc75..9b81c72 onto 9e6dc75 (15 commands)
#
# Commands:
# p, pick = use commit
# r, reword = use commit, but edit the commit message
# e, edit = use commit, but stop for amending
# s, squash = use commit, but meld into the previous commit
# f, fixup = like "squash", but discard this commit's log message
# x, exec = run command (the rest of the line) using shell
# d, drop = remove commit
#
# These lines can be re-ordered; they are executed from top to bottom.
#
# If you remove a line here THAT COMMIT WILL BE LOST.
#
# However, if you remove everything, the rebase will be aborted.
#
# Note that empty commits are commented out
fixup
使用它轻松地清理 commit 并且无须一个更复杂的 rebase 操作。 这篇文章提供了如何以及何时这么做的很好的示例。
cherry-pick
它非常适用于在发布到错误分支上的 commit，无须再次编码。
示例：
$ git cherry-pick 790ab21
[master 094d820] Fix English grammar in Contributing
Date: Sun Feb 25 23:14:23 2018 -0300
1 file changed, 1 insertion(+), 1 deletion(-)
add/checkout/reset [--patch | -p]
假设我们有以下差异：
diff --git a/README.md b/README.md
index 7b45277..6b1993c 100644
--- a/README.md
+++ b/README.md
@@ -186,10 +186,13 @@ bebebe Corrige nome de método na classe InventoryBackend
``
# 坏示例（混合英语和葡萄牙语）
ababab Usa o InventoryBackendPool para recuperar o backend de estoque
-efefef Add `use` method to Credit model
cdcdcd Agora vai
``
+### 样板
+
+这是一个样板，[由 Tim Pope 编写](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)，出现在文章 [**高级 Git 手册**](https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project)。
+
## 贡献
感谢任何形式的帮助，可以帮到我的主题示例：
@@ -202,3 +205,4 @@ 感谢任何形式的帮助，可以帮到我的主题示例：
- [如何书写 Git 的 Commit 信息](https://chris.beams.io/posts/git-commit/)
- [高级 Git 手册 —— Commit 指导](https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines)
+- [A Note About Git Commit Messages](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
我们可以使用 git add -p 来只添加我们需要的补丁，无须修改已经编写的代码。
将较大的变更拆分成小的 commit 或者重置/检出特殊的变更。
暂存这个区块 [y,n,q,a,d,/,j,J,g,s,e,?]? s
拆分成 2 个区块
区块 1
@@ -186,7 +186,6 @@
``
# 坏示例 (mixes English and Portuguese)
ababab Usa o InventoryBackendPool para recuperar o backend de estoque
-efefef Add `use` method to Credit model
cdcdcd Agora vai
``
暂存这个区块 [y,n,q,a,d,/,j,J,g,e,?]？
区块 2
@@ -190,6 +189,10 @@
``
cdcdcd Agora vai
``
+### 样板
+
+这是一个样板，[由 Tim Pope 编写](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)，出现在文章 [**高级 Git 手册**](https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project)。
+
## 贡献
感谢任何形式的帮助，可以帮到我的主题示例：
暂存这个区块 [y,n,q,a,d,/,K,j,J,g,e,?]？
区块 3
@@ -202,3 +205,4 @@ 感谢任何形式的帮助，可以帮到我的主题示例：
- [如何书写 Git 的 Commit 信息](https://chris.beams.io/posts/git-commit/)
- [高级 Git 手册 —— Commit 指导](https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines)
+- [关于 Git 的 Commit 信息的注意事项](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
其他有趣的东西
喜欢吗？
贡献
感谢任何形式的帮助，可以帮到我的主题示例：
- 语法和拼写更正
- 其他语言的翻译
- 参考来源的改进
- 不正确和不完备的信息
灵感、来源和进一步阅读材料
- 如何书写 Git 的 Commit 信息
- 高级 Git 手册 —— Commit 指导
- 关于 Git 的 Commit 信息的注意事项
- Merge 与 Rebase
- 高级 Git 手册 —— 重写历史
转载自:https://juejin.cn/post/6844903838424498189