存储库提交消息礼仪答案

【问题标题】：Repository Commit Msg Etiquette存储库提交消息礼仪
【发布时间】：2011-01-25 22:02:19
【问题描述】：

我从来没有机会与团队合作进行回购，所以我想知道是否有适当的方法来记录您的更改。

例如，可能添加一个标签，例如：错误修复、更新、实施？只是好奇专业人士如何描述他们的承诺。

希望它能帮助我保持项目的井井有条...

【问题讨论】：

标签： svn commit

【解决方案1】：

它应该是对该提交中更改或实施的内容的清晰、简洁的描述。如果您已与问题跟踪系统集成，则问题编号也很有用。

最重要的是，该消息应该对 a) 其他人有意义，以便他们无需查看代码即可理解所做的事情，以及 b) 您自己，当您在一年后查看日志时试图找到哪里你用 foobar 修复了这个错误。

好消息的例子：

修复了条目数为零时程序崩溃的问题（问题＃2857）

错误消息示例：

修复了电子邮件错误

【讨论】：

【解决方案2】：

对此有非常不同的方法，有些人甚至不使用提交消息，而是将 ChangeLog 文件与其他文件一起提交（不过我不推荐它，一直合并很痛苦）。我完全同意 Michael 的观点，只是想指出不同的环境在提交消息时或多或少有帮助，例如 git 有一个 certain preference 消息应该是什么样的。

例如，如果您使用trac，它将帮助您使用某种语法（例如#1234，至少我认为是）将票号放在那里，这将导致它出现在 trac 的时间线中查看时作为超链接。

【讨论】：

【解决方案3】：

尽可能冗长总是最好的主意。

还要确保正确地注释分支、标签和合并。它会让你头疼。

即 MERGE: [from location] [Start repo #] : [end repo #] - [additional comments]

【讨论】：

【解决方案4】：

Commit cmets 应该包含对您所做的什么以及为什么做的简要描述，而不是关于如何做的细节：如果有人需要这种细节，他可以看看差异。不要用多余的实现细节填充 cmets。

【讨论】：