是否有如何编写的版本控制系统的changes message
拇指任何规则或指导原则?在版本控制系统中编写更改消息的准则?
一个明显的答案看起来似乎是a brief description of the most important changes
,但实际上,选择最重要的更改并简要描述这些更改的相关方面并不总是很容易,特别是在开发的早期阶段,添加大量代码时。
是否有如何编写的版本控制系统的changes message
拇指任何规则或指导原则?在版本控制系统中编写更改消息的准则?
一个明显的答案看起来似乎是a brief description of the most important changes
,但实际上,选择最重要的更改并简要描述这些更改的相关方面并不总是很容易,特别是在开发的早期阶段,添加大量代码时。
这取决于项目的目标,我们使用Git和需要四个字段:
小结
相关机票(提交的一行主体)(用于与Trac的整合)
详细报告
˚F uture工作所需
我们的Git仓库有需要提交信息的形式正确,否则填写的服务器拒绝提交挂钩。
通过这种方式,人们可以看到摘要行,并获得了什么事是一个好主意,而详细报告可用于任何棘手和今后的工作让所有人看到什么问题依然存在。
它并不总是容易选择的最重要的变化,并描述这些变化
它可以是,如果你把你的提交紧,集中在一个特定的变化,如在相关方面“逻辑上分开的变更集”:请参阅“git commit frequency”。
(不要忘记wrap your comments properly:。这取决于其他处理工具(电子邮件,打补丁工具),注释行的长度能够决定的事情
我发现它有助于开始过去时态动词提交信息:重构了X类,新增功能Ÿ,轧制回以前的变化等,这洽风格可以很容易通过阅读消息当你稍后回顾他们时会记录日志。
它也是有用的在你的bug跟踪系统添加到跟踪ID的引用,这样你就可以在必要时调查在未来的全背景的变化。
真。我编辑了这样一个问题,即它特别是关于提交时的早期阶段,通常不会像他们应该那样严格。 – Peladao