Version control 在版本控制系统中编写更改消息的指南?
对于如何编写版本控制系统的Version control 在版本控制系统中编写更改消息的指南?,version-control,message,Version Control,Message,对于如何编写版本控制系统的更改消息,是否有经验法则或指导原则 一个显而易见的答案似乎是对最重要的更改的简要描述,但实际上,选择最重要的更改并简要描述这些更改的相关方面并不总是容易的,尤其是在开发的早期阶段,当添加大量代码时 选择最重要的变更并描述这些变更的相关方面并不总是容易的 如果您保持严格的提交并专注于特定的更改,如“逻辑上独立的更改集”:请参阅。 (别忘了:根据其他处理工具(电子邮件、补丁工具),评论行的长度可能很重要。这取决于项目的目标。我们使用Git,需要四个字段: 简要总结(提交的一
更改消息
,是否有经验法则或指导原则
一个显而易见的答案似乎是对最重要的更改的简要描述,但实际上,选择最重要的更改并简要描述这些更改的相关方面并不总是容易的,尤其是在开发的早期阶段,当添加大量代码时
选择最重要的变更并描述这些变更的相关方面并不总是容易的
如果您保持严格的提交并专注于特定的更改,如“逻辑上独立的更改集”:请参阅。(别忘了:根据其他处理工具(电子邮件、补丁工具),评论行的长度可能很重要。这取决于项目的目标。我们使用Git,需要四个字段: 简要总结(提交的一行主题) 相关票据(用于与Trac集成) 详细报告 今后需要开展的工作 我们的Git存储库有一些钩子,要求正确填写提交消息表单,否则服务器会拒绝提交
通过这种方式,人们可以看到摘要行并了解发生了什么,而详细的报告可以用于任何棘手的事情,并且未来的工作可以让每个人看到仍然存在哪些问题。我发现用过去时动词开始提交消息很有帮助:重构了X类,添加了功能Y,回滚了以前的内容通用电气等。这种一致的风格使您在稍后查看邮件日志时可以轻松地阅读它们
在bug跟踪系统中添加对跟踪ID的引用也很有用,这样,如果必要的话,您可以在将来调查更改的完整背景。True。我编辑了一个问题,特别是关于开发的早期阶段,当提交通常不像应该的那样紧密时。