以下是我部门开发时用的分支规范,参考于Linux社区
Tips
分支命名通常遵循一些最佳实践和规则,以便使分支的用途和内容清晰易懂,就在写一个文档的主题一样。
- 功能分支 (Feature Branches)
用于开发新功能。
命名格式:feature/功能名称
示例:feature/user-login,feature/add-shopping-cart - 修复分支 (Bugfix Branches)
用于修复已知的错误或漏洞。
命名格式:bugfix/问题描述 或 fix/问题描述
示例:bugfix/fix-login-error,fix/missing-button - 热修复分支 (Hotfix Branches)
用于修复生产环境中的紧急问题。
命名格式:hotfix/问题描述
示例:hotfix/critical-security-patch - 发布分支 (Release Branches)
用于准备新版本的发布,包含所有待发布的功能和修复。
命名格式:release/版本号
示例:release/1.0.0,release/2.1.0 - 实验分支 (Experiment Branches)
用于尝试新想法或技术,不一定会合并到主分支。
命名格式:experiment/实验名称
示例:experiment/new-algorithm - 任务或用户故事分支 (Task or Story Branches)
根据任务或用户故事来创建分支。
命名格式:task/任务编号-任务描述 或 story/用户故事编号-描述,应与jira关联
示例:task/1234-implement-auth,story/5678-improve-ui - 重构分支 (Refactor Branches)
用于代码重构,不引入新功能。
命名格式:refactor/重构内容
示例:refactor/code-cleanup,refactor/refactor-auth-module - 测试分支 (Test Branches)
用于测试新功能或集成测试。
命名格式:test/测试内容
示例:test/integration-v1