`

【工程规范】SVN提交工作注意事项

svn 
阅读更多

 

一.提交之前先更新

1.         SVN更新的原则是要随时更新,随时提交。当完成了一个小功能,能够通过编译并且自己测试之后,谨慎地提交。

2.         如果在修改的期间别人也更改了svn的对应文件,那么commit就可能会失败。如果别人和自 己更改的是同一个文件,那么update时会自动进行合并,如果修改的是同一行,那么合并时会产生冲突,这种情况就需要同之前的开发人员联系,两个人一起协商解决冲突,解决冲突之后,需要两人一起测试保证解决冲突之后,程序不会影响其他功能。

3.         在更新时注意所更新文件的列表,如果提交过程中产生了更新,则也是需要重新编译并且完成自己的一些必要测试,再进行提交。这样既能了解别人修改了哪些文件,同时也能避免SVN合并错误导致代码有错

二.保持原子性的提交

每次提交的间歇尽可能地短,以几个小时的开发工作为宜。例如在更改UI界面的时候,可以每完成一个UI界面的修改或者设计,就提交一次。在开发功能模块的时候,可以每完成一个小细节功能的测试,就提交一次,在修改bug的时候,每修改掉一个bug并且确认修改了这个bug,也就提交一次。我们提倡多提交,也就能多为代码添加上保险。

三.提交时注意不要提交本地自动生成的文件

一般配置管理员都会将项目中一些自动生成的文件或者与本地配置环境有关的文件屏蔽提交(例如eclipse中的.classpath文件等)。如果项目中没有进行这方面的配置来强行禁止提交这样的文件,请自觉不要提交这样的文件。提交了这样的文件后,别人在更新后就可能与本地的环境冲突从而影响大家的工作。

四.不要提交不能通过编译的代码

代码在提交之前,首先要确认自己能够在本地编译。如果在代码中使用了第三方类库,要考虑到项目组成员中有些成员可能没有安装相应的第三方类库。项目经理在准备项目工作区域的时候,需要考虑到这样的情况,确保开发小组成员在签出代码之后能够在统一的环境中进行编译。

五.不要提交自己不明白的代码

代码在提交入SVN之后,你的代码将被项目成员所分享。如果提交了你不明白的代码,你看不懂,别人也看不懂,如果在以后出现了问题将会成为项目质量的隐患。因此在引入任何第三方代码之前,确保你对这个代码有一个很清晰的了解。

六.提前协调好项目组成员的工作计划

项目经理应该合理分配工作计划。每个成员在准备开始进行某项功能的修改之前,如果有可能,先跟工作小组的成员谈谈自己的修改计划,让大家都能了解你的思想,了解你即将对软件作出的修改,这样能尽可能的减少在开发过程中可能出现的冲突,提高开发效率。同时你也能够在和成员的交流中发现自己之前设计的不足,完善你的设计。

七.对提交的信息采用明晰的标注

在一个项目组中使用SVN,如果提交空的标注或者不确切的标注将会让项目组中其他的成员感到很无奈,项目经理无法很清晰的掌握工作进度,无法清晰的把握此次提交的概要信息。在发现错误后也无法准确的定位引起错误的文件。所以,在提交工作时,要填写明晰的标注,能够概要的描述所提交文件的信息,让项目组其他成员在看到标注后不用详细看代码就能了解你所做的修改。

八.慎用锁定功能

在项目中要慎用锁定的功能,在你锁定了一个文件之后别人就无法继续修改提交该文件,虽然可以减少冲突的发生率,但是可能会影响项目组中其他人员的工作。平时只有在编辑那些无法合并的文件(例如图片文件,flash文件等)时,才适当的采用锁定操作。

分享到:
评论

相关推荐

    Svn使用规则

    总之,SVN的使用需要遵循一定的规范,定期同步和提交,妥善处理冲突,以及正确管理个人工作空间,这样才能确保团队间的协同开发顺利进行。同时,了解和掌握SVN的命令行操作也是很有帮助的,这能提高效率并提供更多...

    SVN服务器配置,权限管理,客户端使用

    #### 注意事项 在使用SVN的过程中,有几点需要注意: 1. **保持良好的命名规范**:合理的文件和目录命名有助于提高代码的可读性和维护性。 2. **频繁提交**:鼓励开发者频繁地提交代码,避免长时间累积大量更改,...

    SVN使用详解

    注意事项部分未在部分内容中显示,但一般而言,它会包括使用SVN时应注意的安全性问题、操作流程规范及常见问题的解决方案。 整个文档的内容是围绕SVN的安装、配置及日常操作展开,提供了详细的步骤和说明,旨在帮助...

    关于SVN+Maven的eclipse配置方案

    - **注意事项**: - 如果遇到依赖问题,可以通过执行`mvn clean install`命令来解决。 - 确保Eclipse与Maven版本兼容。 #### 四、SVN的忽略设置 1. **目标:** 为了保持SVN仓库的整洁,通常需要忽略某些自动...

    c++修改工程名

    6. **版本控制系统**:如果你的工程在Git、SVN等版本控制系统中,你需要更新提交历史中的工程名,可以使用`git filter-branch`或相应的命令。同时,更新版本库中的所有引用。 7. **第三方库和依赖**:如果工程依赖...

    企业Java EE软件开发规范

    - **注意事项**:遵循最佳实践,如避免在工作副本中修改文件等。 #### 第三章:命名规范 本章为Java EE项目中的命名规则提供了一套指导原则。 - **Java包命名规范**:遵循小写字母,并且通常采用反向域名形式。 - ...

    软件工程中的软件工程实践与经验积累.pptx

    通过对这些案例的研究,读者可以更深入地理解软件工程实践中的关键点和注意事项,从而在自己的项目中更好地应用这些知识。例如,可以分析一个成功的软件开发项目是如何通过有效的项目管理、合理的使用开发工具和环境...

Global site tag (gtag.js) - Google Analytics