代码仓库分支管理规范说明书

代码仓库分支管理规范说明书一、总则规范（一）适用范围。本规范适用于公司所有代码仓库的分支管理，包括但不限于Git、SVN等版本控制系统，涵盖研发、测试、运维等所有涉及代码变更的岗位。（二）基本原则。分支命名需统一规范，代码合并需遵循单向流原则，版本迭代需明确标记，冲突解决需及时记录，确保代码仓库结构清晰、操作可追溯。（三）管理责任。各项目组负责人对本组分支管理负总责，开发人员对个人创建的分支质量负责，测试人员对分支合并后的集成质量负责。二、分支类型划分（一）主干分支。1.主干分支仅保留master分支，作为生产环境发布源。2.所有代码变更必须合并至master分支，禁止直接从其他分支推送至生产环境。（二）开发分支。1.每个项目组设立独立开发分支，命名格式为project-name/dev。2.开发分支仅用于新功能开发，完成测试后统一合并至master分支。（三）功能分支。1.功能开发必须基于dev分支创建，命名格式为project-name/feature/功能模块名称。2.功能开发完成后需经过CodeReview，测试通过后方可合并至dev分支。（四）热修复分支。1.紧急线上问题需从master分支创建热修复分支，命名格式为project-name/fix/问题描述。2.热修复完成后需优先合并至master分支，再合并至dev分支。三、分支命名规范（一）主干分支命名。1.统一使用master作为主干分支名称，禁止使用其他名称替代。2.所有项目主干分支必须保持一致，避免混淆。（二）开发分支命名。1.格式为project-name/dev，其中project-name为项目名称缩写。2.禁止使用中文、特殊符号或空格命名分支。（三）功能分支命名。1.格式为project-name/feature/功能模块名称，所有字母小写，多个单词用中划线连接。2.功能模块名称需与产品需求文档保持一致，确保唯一性。（四）热修复分支命名。1.格式为project-name/fix/问题描述，问题描述需具体清晰。2.热修复分支命名需包含时间信息，如project-name/fix/2023-10-27-登录模块崩溃。四、操作流程规范（一）分支创建流程。1.开发人员需在dev分支上发起新功能开发前，通过GitLab等工具发起分支创建请求。2.项目组长需在2个工作日内完成分支创建审批，特殊紧急情况除外。3.分支创建后需立即更新分支保护规则，禁止直接推送至主干分支。（二）代码提交规范。1.提交信息必须遵循统一的格式：模块-功能描述-原因说明。2.提交频率建议每小时至少一次，避免单次提交量过大。3.重大变更需提交变更日志，说明变更原因和影响范围。（三）分支合并流程。1.功能分支合并至dev分支需经过CodeReview，测试通过后方可合并。2.热修复分支合并需先合并至master分支，再合并至dev分支，确保生产环境优先修复。3.合并操作必须使用PullRequest/PullMerge功能，禁止直接gitpush--force操作。（四）分支废弃处理。1.未完成的功能分支需定期清理，超过3个月未使用的分支必须废弃。2.废弃分支需通过GitLab等工具进行强制删除，并记录操作日志。五、版本控制要求（一）版本号管理。1.主干分支版本号格式为X.Y.Z，X为主版本号，Y为次版本号，Z为修订号。2.新功能发布时主版本号递增，修复bug时次版本号或修订号递增。（二）版本发布流程。1.发布前需进行全量测试，确保所有功能正常。2.发布操作必须由运维人员执行，开发人员禁止直接操作生产环境。3.每次发布需记录版本号、发布时间、操作人、变更内容等信息。（三）版本回滚机制。1.主干分支必须保留最近5个版本的历史记录。2.回滚操作需经过项目经理审批，并记录详细操作日志。3.回滚后需立即通知相关测试人员验证功能完整性。六、CodeReview规范（一）Review范围。1.所有功能分支合并前必须进行CodeReview，主干分支合并需重点审查。2.Review内容包括代码逻辑、命名规范、性能优化、安全漏洞等。（二）Review流程。1.开发人员提交PullRequest后，项目组长需在24小时内指派Review人员。2.Review人员需在48小时内完成审查，提出修改意见。3.修改完成后需重新提交Review，直至符合要求。（三）Review标准。1.代码重复率超过30%需重点审查。2.逻辑错误、安全漏洞必须立即修复。3.命名不规范、格式不统一需全部修改。七、冲突解决机制（一）冲突类型划分。1.同级分支冲突：两个分支同时修改同一文件。2.异级分支冲突：合并主干分支时引入的冲突。（二）冲突处理流程。1.发现冲突后需立即标记，避免其他人员继续修改。2.冲突解决必须由最后修改者负责，其他人员禁止擅自修改。3.解决后需进行功能验证，确保冲突未引入新问题。（三）冲突预防措施。1.开发人员需定期同步主干分支最新代码。2.使用Git等工具的冲突解决辅助功能。3.优先使用分支开发模式，避免多人同时修改同一模块。八、组织架构与职责（一）项目管理组。1.负责制定分支管理规范，监督执行情况。2.定期组织分支管理培训，提升团队规范意识。（二）开发团队。1.负责分支创建、代码提交、合并操作等日常管理。2.配合CodeReview，及时修复问题。（三）测试团队。1.负责分支合并后的集成测试，确保功能完整性。2.提交测试报告，明确指出分支问题。（四）运维团队。1.负责主干分支的发布操作，确保发布流程规范。2.记录发布日志，配合版本回滚。九、附则说明