version-control - 在版本控制系统中编写更改消息的指南？

Question

是否有关于如何编写 changes message 的经验法则或指南？版本控制系统？

一个明显的答案似乎是a brief description of the most important changes但实际上，选择最重要的更改并简要描述这些更改的相关方面并不总是那么容易，尤其是在开发的早期阶段，当添加大量代码时。

Answer 1

这取决于项目的目标。我们使用 Git，需要四个字段:

简要总结(一行提交主题)

相关工单(用于与 Trac 集成)

详细报告

future 的工作需要

我们的 Git 存储库有钩子(Hook)，要求正确填写提交消息表单，否则服务器会拒绝提交。

这样，人们可以看到摘要行并很好地了解发生了什么，而详细的报告可以用于任何棘手的问题，并且 future 的工作让每个人都可以看到仍然存在哪些问题。