提交消息的用途是什么?

“给我一份你过去两周所做事情的清单”-老板

你写它们是为了帮助你未来的自我,以及团队中的其他人。给你一些我发现它们有用的背景:

我曾经在一个项目中工作,在这个项目中提交消息是非常宝贵的——不止一次我使用它们来跟踪已经存在多年的代码。在这个项目中,我们的错误跟踪系统也与我们的VCS(ClearCase)集成。所以当您签入一个变更时,它会在提交注释中记录错误号。这非常有助于您准确地追溯更改的内容和原因。

综上所述,虽然提交消息在刚开始时似乎毫无意义(尤其是如果您是唯一一个在项目中工作的人),但一旦您拥有了一个由多个开发人员支持的成功产品,它们就变得非常宝贵。

更新

提交消息的另一个有用特性是,它们要求您查看和总结刚刚所做的更改。即使我记得我所做的更改,我也会经常在签入文件之前对其进行快速的比较。我将再次简单地阅读一遍,以确保没有错别字,我改变了我想要的一切,等等。这是一个简单的方法来检查您的代码中的那些小错误,否则它们会进入您的代码。无论如何,在这样做之后,我对更改的内容有了清晰的了解,因此在签入文件时,我使用它来编写更改的简明摘要。这是一个简单的习惯,它有助于提高代码质量,而您几乎不费吹灰之力。

您的消息更多地针对其他用户而不是您自己。尽管我确保在个人回购中也放置好提交消息。当你在一个项目上偏离正轨,几个月后访问它,以了解最近在一个项目上完成的工作时,会有所帮助。

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

在最好的情况下,提交绑定到特性/bug跟踪程序中的工作项。这样,您就可以轻松地看到实现/修复了哪些特性/缺陷。这不仅有助于了解某个修订是否包含功能或错误修复,而且还可以轻松地创建一个发行说明。

如果没有注释来告诉您承诺的意义是什么?这就像问“为什么书的两边都有书名?”或者“为什么书有索引和页码?”。在我看来,没有对每个更改进行描述的源代码管理日志不会非常有用。

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

• 出现了一个bug,您希望找到上次更改代码的那部分时间。
• 您决定撤消一些更改,并需要决定要还原到哪个修订

对于这两种可能性中的任何一种,如果没有好的提交消息,您都将在代码中查找每个提交的差异,直到您在代码中找到要查找的内容为止。