提交代码时多久发表一次评论？

Question

COMMENTING提交的最佳做法是什么？

一点背景.

我们所有的项目都使用版本控制(Subversion/SVN/Git),
他们中的大多数都被2个或更多开发人员所感动,
我们使用Springloops来托管我们的版本控制,因为它"正常工作"并且比内部开发人员维护它更为干净,
因为我们的许多客户都有特殊的设置,并且因为它为多个用户设置这些环境的工作,我们很少打扰本地开发环境.大多数客户在云中具有开发位置,然后是实时位置.Springloops配置为自动将每个提交推送到开发服务器,并且开发人员必须手动推送到实时位置.

我们的政策一直是评论你犯下的一切,但我们几个最近背叛反对这一想法.

评论所有内容的问题有两个方面,它的工作量更多,而且用处不大.以下是我们看到的问题:

它鼓励人们发表评论,涵盖已经在版本控制中的东西(即我改变了第42行做了等等).您可以比较以获得相同的信息!
或者,它会用无用的注释填充你的评论流,如果你想搜索评论,这将是一个巨大的痛苦.
- IE8的保证金问题
- 另一个解决IE8边缘的问题
- 恢复最后一次修复并在IE8中尝试使用保证金

这些事情中的任何一个都会增加很多时间,并且不会增加任何价值.评论仅在它们具有足够的特定性且足够稀少以便您可以扫描所有内容时才有用.

我们被告知Git以比Subversion更聪明的方式处理这个问题,我们对变化持开放态度,显然拥有本地开发环境并且只提交批量更改也会有所帮助,但基于我们的用例可能会有所改变.效率方面的净损失.

我很想知道人们评论提交的最佳做法是什么,感谢任何反馈!

Answer 1

Git不会为你解决问题; 你需要回答这个"简单"的问题:你怎样才能增加评论的价值？

一些准则:

不要在注释中提及任何从提交本身显而易见的内容(比如更改了哪一行).现代工具将在屏幕上并排显示提交消息和提交.重复工作是没有意义的.
相反,解释你为何做出改变 - 这通常不明显.这是一个bug报告吗？包括错误的ID.你找到了什么？
如果您发现自己经常处于需要在一次提交中提交多个修复程序的情况,那么您需要学会专注.更改代码时不要随心所欲.做一件事,完成它,提交它.然后做下一件事.

如果你偶然发现了某些东西,请做一个笔记(在纸上或在一个额外的文本编辑器中,你一直悬停在屏幕的一角).不要总是打断你的工作!多任务/递归代码编辑对质量和压力水平有严重影响.

您仍将获得"固定IE8边距"提交的长列表,但这本身不是问题.当您说"我们想要搜索评论"时,您必须想出一种方法将有用的信息放入评论中,以便在搜索评论时合理.例如,始终对错误ID使用相同的格式.纯文本不适合搜索,特别是提交简洁的提交消息.

只是省略评论不是解决方案,它既可以是懒惰,也可以是反社会的标志("谁在乎别人有问题呢？")或糟糕的训练("我不知道该写什么").

第一个和最后一个可以通过培训解决.第二个是摆脱风险(即解雇这个人).

世界上没有任何版本控制工具可以帮助您.