aw *_*rud 10 svn version-control
我很好奇在版本化文件提交注释中应该是什么类型的内容.它应该通常描述更改的内容(例如"窗口小部件屏幕已更改为仅显示活动窗口小部件")或者应该更具体(例如"在fetchWidget查询的where子句中添加了一个新条件,以便仅默认检索活动窗口小部件")
一次提交的原子性如何？只是在单个提交中包含更新的查询的文件(例如"更新小部件屏幕以默认仅显示活动小部件"),或者应该和屏幕上的其他几个更改+界面更改共享相同的提交以及更一般的描述喜欢("更新小部件屏幕:A")默认情况下仅显示活动小部件B)添加按钮以切换显示非活动小部件")
我看到subversion提交注释的使用方式非常不同,并且想知道其他人的成功与否.有些评论与"更新文件"一样简短,而其他评论的篇幅很长,其他评论的格式可以查询,并与某些外部系统(如JIRA)相关联.
我曾经非常描述变化的原因以及具体的技术变化.最近我一直在缩减,只是给了一个概括"这是我在这个页面上改变了"的评论.
Kil*_*oth 10
一些准则:
它应简要说明提交包含的内容.这应该包括错误修复或增强的票号.我曾经听过关于撰写评论的最好建议是"代码,好像下一个维护你的代码的人是一个知道你住在哪里的杀人狂"这同样适合提交评论.