提交消息有什么用？

Question

我挣扎着问这个问题但是在这里。 我使用源代码控制几年来使用不同的系统（svn，hg，git），我学习了如何通过遵循指南等来改进我的消息。 但据我记忆，之后从未见过他们。

那么......你如何从自己的提交消息中获利？当我需要回去因为我打破了一些东西而需要一个新的开始时，我通常会回到最新的“节点”（我开始或合并一个分支）。我是否只为那些对项目感兴趣的人们编写这些消息？

此致

Answer 1

您可以将它们作为对未来自我和团队中其他人的帮助。为了给你一些我发现它们有用的背景知识：

我曾经在一个提交消息非常宝贵的项目上工作 - 我不止一次使用它们来追踪多年前的代码。在该项目中，我们的错误跟踪系统也与我们的VCS（ClearCase）集成在一起。因此，当您签入更改时，它会在提交注释中记录错误号。这非常有助于您准确追溯更改的内容和原因。

总而言之，虽然如果您刚刚开始提交消息可能看起来毫无意义（特别是如果您是唯一一个从事该项目的人），那么一旦您拥有生产中受支持的成功产品，它们就会变得非常宝贵。多个开发人员。

更新

提交消息的另一个有用功能是它们要求您查看并总结您刚刚所做的更改。即使我记得我改变了什么，我也经常会在检查之前对文件进行快速区分。我会再次简单地阅读它以确保没有错字，我改变了我想要的一切，等等。这是一种简单的方法来检查代码中的那些小错误，否则这些错误会进入您的代码。无论如何，在执行此操作之后，我清楚地了解了已更改的内容，因此我在使用此文件时会在签入文件时写下更改的简明摘要。这是一个简单的习惯，可以帮助您轻松提高代码质量。

Answer 2

“向我发送你过去两周所做事情的清单” - Boss

Answer 3

您的邮件更适合除您之外的其他用户。虽然我也确保在个人回购中也能提供好的提交信息。帮助您在项目中获得侧面跟踪并在几个月后访问它以获得最近在项目上完成的工作。

Answer 4

我发现的一件事是，提交消息是一种很好的方法，可以防止自己不经常提交。如果我不能将更改放入一个简短的提交消息中，我可能应该更早地提交更改。

Answer 5

在最好的情况下，提交绑定到功能/错误跟踪器中的工作项。这样，您就可以轻松查看已实施/修复的功能/错误。这不仅有助于了解某个修订是否包含某个功能或错误修复，还可以轻松创建发布说明。

Answer 6

如果没有记录就会告诉你它是什么意思？这就像问“为什么书本上有标题？”，或者“为什么书籍有索引和页码？”。在我看来，没有每个更改的描述的源代码控制日志将不会非常有用。

您可能需要引用提交消息的原因包括

• 一个错误已经浮出水面，你想找到最后一段代码改变的时间
• 您决定撤消某些更改，并需要决定要还原到哪个修订

对于这些可能性中的任何一种，如果没有良好的提交消息，您将在每次提交时查看差异，直到找到您在代码中查找的内容。