version-control - 代码提交评论的最佳实践

Question

你用什么模板来评论代码提交？

模板的一个示例是:

(更改 1):(源文件 1.1、1.2):(所做更改的详细信息)，(为什么)

(更改 2):(源文件 2.1):(所做更改的详细信息)，(为什么)

理想情况下，每个更改都应映射到问题跟踪器中的问题。这个模板好吗？

Answer 1

这是我的想法……所有这些都可以根据您的特定开发方法进行解释。

你应该经常提交，每次提交都有一个焦点，因此基于此，注释应该简短并详细说明提交的焦点是什么。

我喜欢在您的评论中发布内容，以及在其他地方详细说明原因和方式(最好是在您的错误跟踪中)。为什么应该是票，并且在关闭票后，您应该有一些关于如何解决该特定问题的注释。

如果不进行其他处理(例如，TRAC/SVN 交互)，则可以引用您的错误跟踪系统。这样做的原因是，如果其他开发人员正在寻找有关提交的更多信息，则可以为他们指明正确的方向。

不要包含特定的文件名，除非修复非常复杂且需要详细信息。即使如此，复杂的细节也可能属于您的实现说明中的错误跟踪，而不是版本控制。编辑过的文件，差异细节等，应该希望包含在版本控制中，我们不想花时间复制这些。

鉴于这些想法，对我来说一个示例提交评论将类似于

Req3845: Updated validation to use the new RegEx validation developed in Req3831.

简而言之，传达更改的内容，并为其他人提供某种引用以获取更多信息，而无需追捕您。