分支命名不是 Git 强制要求,但一个好的命名规范能大幅提升团队协作效率、代码可读性、CI/CD 自动化友好度、历史追溯能力。
核心原则
<type>/<description>-<id>
-
全小写:全小写字母(a-z) + 数字(0-9) + 连字符 -(kebab-case),避免大小写混用(如 Feature/user-login 和 feature/user-login 易被 Git 识别为不同分支),跨平台兼容性更好,排序更友好
-
用连字符
-分隔:禁止用空格、下划线_、特殊符号(除 / 分层外) -
分层清晰:使用 / 分组(前缀/具体描述)→ 让同类分支自动聚在一起,便于筛选
-
前缀(type)必须有:一眼看出这是什么类型的工作
-
描述部分简洁、有意义(3–8 个单词为宜): 避免太泛(update、fix、new)或太长
-
强烈推荐:带 ticket/issue ID 和 开发者姓名缩写
长度建议:整体不超过 50–60 个字符(GitLab UI 显示友好)
分支类型 <type>
- 基础分支(长期保留)
| 用途 | 命名 | 说明 |
|---|---|---|
| 主分支 | main 或 master | 存放生产环境可用代码,禁止直接提交,仅通过合并更新 |
| 开发分支 | develop | 日常开发的集成分支,功能分支的归宿,永远最新,功能最齐全 |
| 发布分支 | release/* | 预发布准备,如 release/v1.2.0(版本号遵循语义化) |
- 临时分支(完成后删除)
| 用途 | 命名 | 说明 |
|---|---|---|
| 功能开发 | feature/* | 用于开发新功能或需求,从开发分支(develop)创建,完成后合并回develop |
| Bug 修复 | bugfix/* 或 fix/* | 开发阶段修复bug,从develop分支创建,修复后合并回develop |
| 紧急修复 | hotfix/* | 紧急生产环境修复,已上线版本的严重问题,从 master 分支创建,修复后需同时合并到 master 和 develop |
分支描述 <description>
-
全小写,小写字母 + 数字
-
使用
-连接,不建议使用下划线 -
建议参照代码命名规范,动宾结构,简洁描述核心任务,长度50字符以内
例:
feature/order-pay-refactor-xyz
feature/add-dark-mode-toggle-jira-415
分支来源标识 <id>
核心是便于追溯,可使用个人姓名缩写,需求编号,或 ticket/issue ID 等

1125

被折叠的 条评论
为什么被折叠?



