应该以现在还是过去时态写入提交消息？

Question

那么你认为哪个更好,更直观？

Fixed the XXX bug in YYY
Fix the XXX bug in YYY
Fixes the XXX bug in YYY
Fixing the XXX bug in YYY

请提供您的理由.注意我从您的一般观点来看,这意味着您不应该尝试将其与您首选的svn/cvs工具或编程语言相关联,而应将其视为应该/可以应用于任何工具和编程语言的东西.

Answer 1

我认为这些消息对于其他开发人员来说似乎是正确的.他们还没有应用更改,并且存在一个隐含的问题,"应用此更改集/补丁会做什么？" 它将"修复YYY中的XXX错误"!

对于其他动词来说,将它们作为命令编写似乎更自然,如果你有一个特定的目标,你可以更好地工作 - 你可以在工作完成之前逐字地编写提交摘要和前期测试.

我没有给它施加太大的重量,但对我而言,这是阻力最小的路径,同时保持一致性.

Answer 2

我个人用过去时("修复")去,因为当我提交bug时,修复了(或者我不会提交).

Answer 3

我更喜欢以现在时态看到提交消息.这样,消息描述了diff的作用(因为你可能会将差异甚至整个提交拉到另一个分支中).因此,提交消息没有描述它"做"做了什么......它描述了提交本身"做"的作用.所以它应该是现在时.

想象一下,孤立地看待差异并试图决定是否应用它.以过去时态拥有头衔是没有意义的.

Answer 4

恕我直言,如果你想要它描述而不需要考虑上下文,那么"固定"绝对是唯一正确的变体.

关于直观性 - 如果我查看一些更改日志,我肯定会明白你的意思是修复了这个错误,因为我知道使用这个词的上下文,但是如果这个词写在这个自我中,我的大脑会更快地抓住它指定方式.

"修复"是最糟糕的选择恕我直言,因为它不仅可以解释为描述补丁的作用(用于),而且还可以解释为错误状态,这意味着它正在工作并且尚未解决.

Answer 5

Fix the XXX bug in YYY
Teach the XXX to be more ZZZ
Correct typos in javadoc

一般来说:{imperative verb} {affected object} {optional qualifiers}

当我考虑补丁集时,命令式形式适合所有用例.

无论您的选择如何,我都发现一致性有助于提高可读性.选择一个并坚持下去.

Answer 6

我认为用现在时写出当前提交是一个好主意,因为当你以过去时态引用先前的提交时它会更清楚.

Answer 7

我认为这并不重要。目的是：

1）传达正在做什么或正在做什么，这样可以更容易地发现错误，更容易地恢复问题，并且通常能够更容易地维护项目。

2) 传达哪些工单已修复（如果有），以便审核员（如果在您的公司中使用它们）可以看到哪些更改对应于哪些工单）。

最后，如果它已经被修复，“修复”就没有意义，如果您仍在处理它，“已修复”就不正确。