存储库提交Msg Etiquette

Question

我从来没有机会与一个团队合作回购,所以我想知道是否有适当的方式来记录你的变化.

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

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

Answer 1

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

最重要的是,消息应该对a)其他人有意义,以便他们在不查看代码的情况下理解所做的事情,并且b)自己,当你在一年后查看日志时试图找到你修复的位置foob​​ar的bug.

好消息的示例:

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

错误消息的示例:

Fixed email bug