SVN使用规范及要求V1.0.doc

SVN使用规范及要求 V1.0  文档变更历史 序号 变更说明 作者 版本号 日期 1 建立初始文档 张维波 V1.0 2015-07-20 目 录 1. 引言 4 1.1 编写目的和范围 4 1.2 相关术语 4 2. 使用规范及要求 4 2.1 SVN账号申请及管理 4 2.2 使用规范 4 3. SVN具体使用规范 7 3.1 TortortoiseSVN使用 7 3.2 Myeclipse中SVN使用规范 7  1. 引言 1.1 编写目的和范围 本制度为研发部SVN配置管理的准则和依据，所有与SVN配置管理的行为都必须遵照并服从于本制度。 本制度适用于研发部全体员工。 1.2 相关术语 2. 使用规范及要求 2.1 SVN账号申请及管理 1. 用户帐号注册：新进员工没有SVN帐号，通过邮件联系SVN管理员，邮件正文注明申请SVN普通帐号，管理员处理完帐号注册事宜后，会邮件回复。 注：普通帐号，只对个人目录有读取权限。 2. 权限的申请： 根据员工所参与的项目，SVN管理员对其开放相应目录的读、写权限。 3. 账号注销：员工离职后，对其账号进行注销。 2.2 使用规范 1、使用自己的账户和密码 开发人员进行开发，必须使用自己的账户登录，禁止使用他人账户进行SVN各项操作。 2、不要签出（SVN Checkout）整个目录。 工作中需要对项目或解决方案进行任何操作时，应使用SVN请求最新代码或文件。不要签出（SVN Checkout）整个目录（切记对整个项目进行更新或提交动作），除非特别必要，不应同时签出过多的项。使用myeclipse进行项目更新时，要使用资源同步，只更新或提交有需要的代码。 3、先更新（SVN Update），再提交（SVN Commit） 每天在进行开发工作之前先更新代码，下班时提交可用的代码。 SVN更新的原则是要随时更新（SVN Update），随时提交（SVN Commit）。当完成了一个小功能，能够编译并且通过自己测试之后，谨慎地提交。 如果在修改的期间别人也更改了SVN的对应文件，那么Commit就可能会失败。如果别人和自己更改的是同一个文件，那么Update时会自动进行合并，如果修改的是同一行，那么合并时会产生冲突，这种情况就需要同之前的开发人员联系，两个人一起协商解决冲突，解决冲突之后，需要两人一起测试保证解决冲突之后，程序不会影响其他功能。 在更新时注意所更新文件的列表，如果提交过程中产生了更新，则也是需要重新编译并且完成自己的一些必要测试，再进行提交。这样既能了解别人修改了哪些文件，同时也能避免SVN合并错误导致代码有错。 4、多提交（SVN Commit），不要长时间签出（SVN Checkout）项目或解决方案，减少因多人对同一文件进行操作而产生的文件冲突。 每次提交的间歇尽可能地短，以几个小时的开发工作为宜。例如在更改UI界面的时候，可以每完成一个UI界面的修改或者设计，就提交一次。在开发功能模块的时候，可以每完成一个小细节功能的测试，就提交一次，在修改bug的时候，每修改掉一个bug并且确认修改了这个bug，也就提交一次。我们提倡多提交，也就能多为代码添加上保险。 5、不要提交不能通过编译的代码 代码在提交之前，首先要确认自己能够在本地编译。如果在代码中使用了第三方类库，要考虑到项目组成员中有些成员可能没有安装相应的第三方类库。开发人员在准备项目工作的时候，需要考虑到这样的情况，确保开发小组成员在签出（SVN Checkout）代码之后能够在统一的环境中进行编译。 6、每次提交必须书写明晰的标注 在一个项目组中使用SVN，如果提交空的标注或者不确切的标注将会让项目组中其他的成员感到很无奈，项目经理无法很清晰的掌握工作进度，无法清晰的把握此次提交的概要信息。在发现错误后也无法准确的定位引起错误的文件。所以，在提交工作时，要填写明晰的标注，能够概要的描述所提交文件的信息，让项目组其他成员在看到标注后不用详细看代码就能了解你所做的修改。 7、提交时注意不要提交本地自动生成的文件 例如eclipse中的.classpath文件，Windows生成的缩略图Thumbs.db，项目编译生成的临时文件.obj, .class等等。如果项目中没有进行这方面的配置来强行禁止提交这样的文件，请自觉不要提交这样的文件。提交了这样的文件后，别人在更新后就可能与本地的环境冲突从而影响大家的工作。 8、不要提交自己不明白的代码 代码在提交入SVN之后，你的代码将被项目成员所分享。如果提交了你不明白的代码，你看不懂，别人也看不懂，如果在以后出现了问题将会成为项目质量的隐患。因此在引入任何第三方代码之前，确保你对这个代码有一个很清晰的了解。 9、慎用锁定功