【转】SVN提交一般原则
写在前面:
最近, 跳槽了.
来到了一家感觉QIAN景不错的创业公司. 由于是开始, 规模比较小, SVN的管理工作, 也有我来承担. 今天发生了一些相当不愉快的事情, 就是因为一个同事, ①签入代码无法编译, ②签入代码不写注释, 找不到变更记录. 找来这么一篇文章放到博客上, 希望能帮助看到的各位.
=======================割==割===割=========================
最近在合作开发,用SVN给代码和文档做版本控制,由于是刚学会使用,总是问题多多:像文件冲突,更新出问题等等,一开始以为很简单的SVN远不是想象的那样,只有正确的使用才能真正发挥他的作用。
对于提交更新,建议还是做一点提交一点,当然是在保证代码没有错误的情况下,这样方便做恢复更改。找了一点资料,关于更新的原则:
①负责而谨慎地提交自己的代码
SVN更新的原则是要及时更新,及时提交。当完成了一个小功能,能够通过编译并且并且自己测试之后,尽量早的提交,这样也保存了历史版本,必要时候可以回滚;在开始一天的工作之前,最后update一下项目。
如果提交过程中产生了冲突,则需要同之前的开发人员联系,两个人一起协商解决冲突,解决冲突之后,需要两人一起测试保证解决冲突之后,程序不会影响其他功能。
②保持原子提交(不要不经意间修改并提交了别人的文件)
仅提交你修改的部分,最好不要一下子将整个项目提交;
当完成一个功能或文件后,最好提交。我就遇到完成某个功能后,没有提交,后来又做了更改,结果代码出现bug,无法恢复到正常时的代码。
③不要提交自动生成的文件
VisualStudio等开发工具在生成过程中会产生很多自动文件,如.suo等配置文件,Debug,Release,Obj等编译文件,以及其他的一些自动生成,同编译代码无关的文件,这些文件在提交的时候不应该签入,如果不小心签入了,需要从仓库中删除。
④不要提交不能通过编译的代码
代码在提交之前,首先要确认自己能够在本地编译。进行SVN提交更新时最好是代码在提交前已经通过自己的测试。
⑤不要提交自己不明白的代码
代码在提交入SVN之后,你的代码将被项目成员所分享。如果提交了你不明白的代码,你看不懂,别人也看不懂,如果在以后出现了问题将会成为项目质量的隐患。因此在引入任何第三方代码之前,确保你对这个代码有一个很清晰的了解。
⑥提前宣布自己的工作计划(多人协作同一个模块的时候)
在自己准备开始进行某项功能的修改之前,先给工作小组的成员谈谈自己的修改计划,让大家都能了解你的思想,了解你即将对软件作出的修改,这样能尽可能的减少在开发过程中可能出现的冲突,提高开发效率。同时你也能够在和成员的交流中发现自己之前设计的不足,完善你的设计。
⑦对SVN提交更新的信息采用明晰的标注(类似在代码里写的注释)
例如可以采用下列格式
+)表示增加了功能
*)表示对某些功能进行了更改
-)表示删除了文件,或者对某些功能进行了裁剪,删除,屏蔽。
b)表示修正了具体的某个bug。
原文转自MyException.cn.
===================================================
最后, 贴上一个我两年前的一篇微博截图, 我觉得, 我当时骂的好机智:
Lionden 2015年12月2日
E-mail:hsdlionden@hotmail.com
转载请注明原文地址和博客园Lionden:http://www.cnblogs.com/lionden/