正确的提交消息

Question

什么是提交消息？我一直在写它们作为对我所做的事情的解释，但是我最近和一位同事写了一个讨论，然后写了提交信息来解释他为什么这样做。哪一个是正确的，还是完全有另一个答案？

注意：我完全不知道是否有一个“正确”的答案。因此，我将其标记为社区维基，并且不会接受答案。 Upvotes将决定胜利者：）

Answer 1

作为个人偏好，我可以通过直接查看文件中的差异来判断是什么。 为什么是我不能仅仅通过查看实际变化而推断的。

如果更改很重要或很复杂，那么我不仅会包含原因，还会包含 的简要概述。

Answer 2

我认为两者都很有用。快速描述已更改的内容（“为AddUserForm添加长度验证”）比查看差异更容易，特别是如果您正在浏览多个提交。为什么要做出改变，修复了什么错误等等，显然也是一件非常好的事情。

Answer 3

我将提交消息用作更改的 executive summary 。

  

执行摘要是一份简短的文件，其中总结了读者可以快速熟悉大量材料而无需全部阅读。

为什么在其他地方被记录：问题跟踪系统，需求文档等。我还包括从提交消息到 why 的链接，反之亦然。

Answer 4

提交消息是您对它们所做的，但是当特定文件有数百个或项目有数千个时，您希望能够扫描它们以查找某些更改或更改的性质。实际上，它们就像代码注释一样，它们需要尽可能有用，但要简洁而精辟。也许最好将它们视为推文 - 在短时间内传达最大意义。

作为跨越数十年的大型代码基础工作的人，以及跨越一年或两年的小型项目，我发现在组合提交日志时没有比“oops”或“修复bug”这样的消息更令人愤怒的了。如果您修复了错误，请告诉我们哪一个（错误号码，至少）。对于不可避免的取证来说，这一切都很重要。