SVN代码管理规范与目录结构详解

需积分: 14 9 下载量 36 浏览量 更新于2024-09-09 收藏 18KB DOCX 举报
"SVN使用规范" 在软件开发中,版本控制系统如Subversion(SVN)是团队协作的重要工具,它帮助开发者管理代码版本,确保代码的一致性和可追踪性。以下是对公司SVN使用规范的详细说明: 1. **目录结构**: - `\src`:主要存放开发用的源代码。 - `\src\PHP`:专门存储PHP工程代码的目录。 - `\src\PHP\snake_1.0` 和 `\src\PHP\snake_2.0`:分别用于存放不同阶段的项目代码,如旧版和当前正在维护的版本。 - `\src\PHP\snake_2.0\MainBranch`:主分支,日常开发在此分支上进行,遵循严格的提交原则。 - `\src\PHP\snake_2.0\Trunk`:阶段性的开发版本存放,每次迭代后供测试人员进行测试。 - `\src\PHP\snake_2.0\Release`:测试完成后,发布的产品版本会存放在该目录,且只允许读取。 - `\src\SQL`:可能包含数据库脚本或其他非PHP相关的文件。 2. **提交原则**: - **即时更新与提交**:开发者应随时更新代码,完成一小部分功能后立即提交,以保持代码同步并减少冲突。 - **提交粒度**:提交的代码应是可独立运行、测试通过的最小功能单元。 - **代码编译**:提交前确保代码能在本地编译通过。 - **冲突解决**:若发生冲突,需与相关开发者沟通,共同解决冲突并测试结果。 - **提交注释**:每次提交时提供清晰的描述,以便团队了解修改内容。 - **不提交本地文件**:避免提交IDE生成的配置文件、临时文件或系统生成的文件。 3. **锁定功能**: - 只对文档进行锁定,不推荐对代码使用锁定,以保持代码库的活跃和协作。 4. **版本命名**: - 版本号遵循`大版本号.中级功能上线迭代版本号.每次小功能上线或bug修复版本号`的格式,如`2.1.13`,便于管理和跟踪。 遵循这些规范,团队可以更有效地协同开发,保证项目的顺利进行,并降低因版本控制问题引发的错误和延迟。对于新加入的成员来说,理解并遵守这些规则是至关重要的,因为这直接影响到团队的整体效率和代码质量。
2020-04-13 上传
介绍SVN各个目录使用规范 Svn目录使用规范 TortoiseSVN客户端工具 选择创建SVN目录结构的选项(生成trunk、branches、tags目录),如下图: 1、 trunk是主分支,是日常开发进行的地方。 2、branches是分支。一些阶段性的release版本,这些版本是可以继续进行开发和维护的,则放在branches目录中。 3、tags目录一般是只读的,这里存储阶段性的发布版本,只是作为一个里程碑的版本进行存档。 注:在这需要说明下分三个目录的原因,如果项目分为一期、二期、三期等,那么一期上线时的稳定版本就应该在一期完成时将代码copy到branches上,这样二期开发的代码就对一期的代码没有影响,如新增的模块就不会部署到生产环境上。而branches上的稳定的版本就是发布到生产环境上的代码,如果用户使用的过程中发现有bug,则只要在branches上修改该bug,修改完bug后再编译branches上最新的代码发布到生产环境即可。tags的作用是将在branches上修改的bug的代码合并到trunk上时创建个版本标识 Trunk目录:Doc(文档库,放项目相关文档类)、sourcecede(代码库) Doc目录下按项目存放文档,以下以proj1为例做说明 Proj1----项目名 1、Controlled------组织级scm建一个名为controlled的目录,当项目某文档通过评审后,组织级scm从项目目录下找到那文档,复制到controlled目录下。(一般用不到) 2、Develop---开发文档 2.1、Design----设计文档 2.1.1、DbDesign---数据库设计文档 2.1.2、HLD---概要设计 2.1.3、InterfaceDesign---接口设计 2.1.4、ServiceDesign---服务设计 2.2、REQ---需求文档 2.3、SRS---软件需求规格说明 2.4、Test---测试文档 2.4.1、Review---可空 2.4.2、TestCese---测试用例 2.4.3、TestDoc---测试文档 2.4.4、TestEnv---测试环境说明 2.4.5、TestReport---测试报告 3、Document---项目文档 4、Management---管理文档 4.1、Meetings--会议纪要 4.2、PIM--- 4.3、Plan---计划 4.3.1、review 4.3.2、SDP---软件开发策划文档 4.3.3、SPP---软件项目策划文档 4.4、report---报告 4.4.1、Milestonereport---版本报告 4.4.2、ProjectTrackReport---项目跟踪报告 4..4.3、SCM---软件配置管理文档  4.4.4、SQA---软件质量保证计划 4.4.5、项目周报 4.5、Sow---工作说明书 4.6、Summarize---总结 4.7、Template---模板 4.8、Trainning---培训文档 打标签/分支有两种方式: 1、选中项目,就是trunk下的本地项目,右击,选中Branch/Tag,出现如下对话框。 下图中的配置完成了之后,点击OK即可完成“打标签/分支”。 2、直接在SVN上在对应的标签/分支目录下创建对应的版本文件夹,将trunk下稳定版本的代码直接copy到对应的文件目录下即可。