提交消息有什么用?

eri*_*ert 5 version-control commit-message

我挣扎着问这个问题但是在这里.我使用不同系统(svn,hg,git)的多个项目使用源代码控制几年,我学会了如何通过遵循指导等来改进我的消息.但据我记忆,我从来没有看过它们.

那么......你如何从自己的提交消息中获利?当我需要回去因为我打破了一些东西而需要一个新的开始时,我通常会回到最新的"节点"(我开始或合并一个分支).我是否只是为监控项目的人编写这些消息,他们很好奇发生了什么?

问候

Jus*_*ier 7

你把它们写成对未来自我和团队中其他人的帮助.为了给你一些我发现它们有用的背景知识:

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

总而言之,虽然如果你刚刚开始提交消息似乎毫无意义(特别是如果你是唯一一个从事该项目的人),一旦你拥有一个多个开发人员在生产中支持的成功产品,它们就会变得非常宝贵.

更新

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


sho*_*osh 6

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

  • 这可能与信任无关.特别是在一个想到的案例中,他只是想知道在发布说明文档中要放什么. (3认同)