我已经阅读了各种 Git 教程,包括官方的教程,它们似乎都告诉我用现在时编写 Git 提交注释是一种很好的惯例和习惯。
这是为什么?其背后的原因是什么?
我已经阅读了各种 Git 教程,包括官方的教程,它们似乎都告诉我用现在时编写 Git 提交注释是一种很好的惯例和习惯。
这是为什么?其背后的原因是什么?
Git 是一个分布式 VCS(版本控制系统)。多人可以在同一个项目上工作。它将从许多来源获得变化。
而不是写消息来说明提交者做了什么。最好将这些消息视为在将提交应用于repo后将要做什么的说明。
所以写一个这样的消息
修复错误#1234
代替
修复错误 #1234
将 git log 视为不是您的操作历史记录,而是所有提交所做操作的序列描述。
关于它的黑客新闻有一个很大的话题。在那里你会得到这个约定背后的更多原因。
这只是一个(相对)常见的约定,因此可以在项目中一致地提交消息。向 Git 提交补丁的建议(例如)来自Documentation/SubmittingPatches
.
- 描述命令语气的变化,例如“make xyzzy do frotz”而不是“[This patch] makes xyzzy do frotz”或“[I] changed xyzzy to do frotz”,就好像你正在命令代码库改变它的行为.
从括号中的主语可以看出,该约定消除了对不提供任何有用好处的提交动词的重复(或暗示)主语的需要。