2010-05-10 95 views
5

我挣扎着问这个问题,但在这里。 我使用源代码控制,因为多年来使用不同系统(svn,hg,git)的多个项目,并且我学会了如何通过遵循指导等来改进我的消息。 但是据我记忆,我从来没有看过他们之后。提交消息的用途是什么?

所以......你如何从自己的提交信息中获益?当我需要回头因为我砸了一些东西而需要重新开始时,我通常会回到最新的“节点”(我开始或合并分支机构)。我是否只为监控项目的人编写这些消息,他们对发生了什么事情感到好奇?

问候

回答

6

“送我的,你在过去两周内做的事情的清单” - 老板

+0

我必须和老板谈谈信任和程序员的工作方式。或者离开;) – ericteubert 2010-05-11 08:35:34

+3

这可能与信任无关。特别是在一个想到的案例中,他只想知道发布说明文档中应该写些什么。 – shoosh 2010-05-11 09:10:10

+0

好点shoosh – ericteubert 2010-05-11 11:49:09

3

有一件事我发现是,提交信息让自己从一个好办法没有足够的承诺。如果我不能把这些修改放到一个简短的提交信息中,那么我应该早一点提交修改。

4

你的消息比其他用户多于你自己。尽管我确保即使在个人回购协议中也提交了良好的提交消息。有助于您在项目中受到偏离,并在该项目的几个月内访问,以便掌握最近在项目上完成的工作。

+2

没有什么比讨厌更新并获得几十个更新文件而没有消息告诉我为什么必须更改这些文件。 – tster 2010-05-10 21:55:22

+0

同意。我看到代码提交给一个共同的图书馆,但却不知道它们为什么被制作出来 - 我喜欢它);) – 2010-05-11 01:16:55

7

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

我曾经在一个项目中提交消息非常宝贵 - 我不止一次使用它们来追踪那些年前的代码。在该项目上,我们的错误跟踪系统也与我们的VCS(ClearCase)集成在一起。因此,当您检入更改时,它会在提交评论中记录错误编号。这非常有用,可以让您追溯到底发生了什么变化以及原因。

所以总结一下,尽管如果你刚开始时(尤其是如果你是唯一一个在项目上工作的)提交消息可能看起来毫无意义,但是一旦你有一个成功的产品支持,它们就变得无价了由多个开发人员。

更新

提交信息的另一个有用的特征是,它们需要你回顾和总结,你刚刚所做的更改。即使我记得我已经改变了什么,在检查文件之前我会经常对文件做一个快速区分。我会再次简要地读一遍,以确保没有错字,改变了我的意思等等。这是一种简单的方法来检查您的代码,以找出那些会以其他方式进入代码的小小错误。无论如何,在做完这些之后,我清楚地知道发生了什么变化,因此我使用它在签入文件时编写了简要的变更摘要。这是一个简单的习惯,可以帮助您提高代码质量,而您却不费吹灰之力。

1

在最好的情况下,提交会绑定到功能/ bug跟踪器中的工作项。这样你就可以很容易地看到哪个功能/ bug已经被执行/修复。这不仅有助于了解某个修订版是否包含功能或错误修复,还可以轻松创建发行说明。

1

没有记录的提交点会告诉你它是什么?这就好比问'为什么书上有书名?',或者'为什么书有索引和页码?'。在我看来,没有描述每个更改的源代码控制日志不会非常有用。

原因,您可能需要参考的提交信息包括

  • 的错误已经浮出水面,你想找到在代码的那部分最后
  • 您决定撤消一些变化和需求变更以决定将哪个修订版本还原为

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