为什么以现在时态描述git提交被认为是好的做法?

时间:2012-12-13 13:54:13

标签: git commit commit-message

我已经阅读了各种Git教程,包括官方教程,他们似乎都告诉我用现在时态编写Git提交注释是很好的约定和做法。

为什么?背后的原因是什么?

2 个答案:

答案 0 :(得分:44)

Git是一个分布式VCS(版本控制系统)。多人可以在同一个项目上工作。它会从许多来源得到改变。
而不是写出说明提交者做了什么的消息。最好将这些消息视为在repo上应用提交后将要执行的操作的说明

所以写一个这样的消息

  

修复错误#1234

而不是

  

修正了错误#1234

将git日志视为您的操作历史记录,而不是所有提交内容的序列描述。

hacker news上有一个关于它的重要帖子。在那里,你将会有更多理由支持这一惯例。

答案 1 :(得分:13)

这只是一个(相对)常见的约定,因此提交项目中的提交信息是一致的。向Git提交补丁的建议(例如)来自Documentation/SubmittingPatches

  
      
  • 描述了命令性情绪的变化,例如: “让xyzzy做frotz”   而不是“[这个补丁]使xyzzy做frotz”或“[我]改变了   xyzzy做frotz“,好像你是在给代码库发号码   改变其行为。
  •   

从括号中的主题中可以看出,这个约定消除了对提交动词的重复 - 或者隐含 - 主语的需要,但没有提供任何有用的好处。