Git 分支命名的常用规范
主流分支命名规范:feature/、bugfix/、hotfix/、release/ 前缀加短横线描述(如 feature/user-auth),可带 issue 号(feature/123-login)。全小写、用连字符、不含空格。Git Flow 和 GitHub Flow 各有惯例。
行业通行的做法:类型/简短描述,全小写、单词用连字符分隔、带上 issue 编号。例如 feature/123-user-login、hotfix/payment-timeout。
常用前缀
| 前缀 | 用途 | 示例 |
|---|---|---|
feature/ |
新功能 | feature/oauth-login |
bugfix/ |
开发期 bug 修复 | bugfix/456-cart-count |
hotfix/ |
线上紧急修复 | hotfix/payment-500 |
release/ |
发布准备 | release/2.1.0 |
chore/ |
杂务(升级依赖等) | chore/upgrade-react19 |
docs/ |
文档 | docs/api-readme |
命名细则
- 全小写:避免大小写敏感问题(Linux 服务器 vs macOS 开发机);
- 连字符分词:
user-auth而非userAuth或user_auth; - 带 issue 号:
feature/PROJ-123-oauth-login,与 Jira/GitHub Issues 联动可追溯; - 不用空格和特殊字符:下划线、点、中文都尽量避免。
两大工作流的惯例
- Git Flow:
main+develop长期分支,feature/release/hotfix 短分支; - GitHub Flow:只有
main+ 短生命周期功能分支,PR 合并即删。
常见问题(FAQ)
Q:分支名能改吗?
能:git branch -m 旧名 新名,远程需要推新删旧。但分支名是协作接口,定好规范比事后改名省事。
Q:怎么强制团队遵守?
服务端钩子或 CI 检查分支名正则;GitHub 可用分支保护规则 + 命名约定检查 Action。
Q:个人试验性分支也要规范吗?
可以用 wip/、spike/ 前缀标明"这是草稿",方便定期清理时一眼识别。