存储库提交Msg Etiquette

时间:2010-03-10 13:55:39

标签: svn repository message commit etiquette

我从未有机会与团队合作,因此我想知道是否有适当的方式记录您的更改。

例如,可能添加一个标签,例如:bugfix,update,implement?只是好奇专业人士如何描述他们的提交。

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

4 个答案:

答案 0 :(得分:7)

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

最重要的是,消息应该对a)其他人有意义,以便他们了解在不查看代码的情况下完成了什么,以及b)自己,当你在一年后查看日志时试图找到哪里你用foobar修复了这个bug。

好消息示例:

Fixed the bug where the program would crash if the number of entries was zero
(issue #2857)

错误消息的示例:

Fixed email bug

答案 1 :(得分:2)

提交评论应该包含你做了什么的简要描述以及为什么你做了它,没有详细说明如何:如果有人需要这样的细节,他可以看看差异。请勿使用冗余的实现细节填充注释。

答案 2 :(得分:0)

有很多不同的方法,有些人甚至不使用提交消息,而是提交一个ChangeLog文件和其他文件(我不推荐它,但是一直很难合并)。我一直同意迈克尔的观点,只是想指出不同的环境在提交消息方面或多或少都有帮助,例如git有certain preference消息应该是什么样的。

如果您正在使用trac,它会帮助您使用特定语法(例如#1234,至少我认为是)将票号放在那里,这将导致它在trac的时间轴中查看时显示为超链接。

答案 3 :(得分:0)

尽可能详细总是最好的主意。

还要确保正确评论分支,标签和合并。它会让你头疼。

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