分支命名约定

分支命名约定的重要性

良好的分支命名约定能提升团队协作效率，减少沟通成本。清晰的命名让开发者一眼就能理解分支用途，避免合并冲突和误操作。没有统一规范时，可能出现fix-bug、hotfix_login等混乱命名，导致后期维护困难。

基本命名原则

分支名称应当简短但具有描述性，通常采用小写字母和连字符组合。避免使用特殊字符、空格或中文，保持与Git工具兼容性。以下是一些核心原则：

1. 使用小写字母
2. 单词间用连字符(-)连接
3. 包含上下文信息
4. 避免过长(建议不超过5个单词)
5. 反映分支目的而非作者信息

常见分支类型及命名模式

功能开发分支

功能分支用于开发新特性，通常从main或develop分支切出。命名模式：

feature/[简短描述]-[关联事项ID]

示例：

# Jira事项ID为PROJ-123的登录页面开发
feature/login-page-PROJ-123

# 无事项追踪系统的简单功能
feature/user-profile-avatar

缺陷修复分支

修复分支专门处理生产环境或测试环境发现的缺陷：

fix/[问题描述]-[关联事项ID]

实际例子：

# 修复登录按钮点击无效的问题
fix/login-button-click-PROJ-456

# 紧急生产问题修复
fix/payment-amount-calculation

发布分支

准备发布的代码分支需要特殊标记：

release/[版本号]

版本号应当遵循语义化版本控制：

release/1.2.0
release/2.0.0-rc.1

热修复分支

针对生产环境紧急问题的修复：

hotfix/[问题简述]

典型示例：

hotfix/security-patch-cve2023
hotfix/checkout-flow-500-error

高级命名技巧

包含环境信息

当分支对应特定环境时，可在命名中加入环境标识：

feature/search-api-staging
fix/header-layout-prod

日期标记法

对需要长期存在的实验性分支，可加入创建日期：

experiment/new-algorithm-20230515

团队前缀

大型项目多个团队协作时，可添加团队标识：

mobile/feature/offline-mode
backend/fix/api-timeout

自动化工具集成

现代Git平台支持通过分支名称自动触发流程。例如：

# 自动关联Jira事项
feature/PROJ-123-description

# 触发CI/CD流水线
build/android-beta-1.3.0

命名检查脚本示例

可通过Git钩子或CI脚本强制检查命名规范。以下是Node.js实现的检查脚本：

// scripts/validate-branch-name.js
const branchName = require('current-git-branch')();
const patterns = [
  /^(feature|fix|hotfix|release)\/[a-z0-9-]+(\-[A-Z]+-\d+)?$/,
  /^experiment\/[a-z0-9-]+\-\d{8}$/,
  /^[a-z]+\/(feature|fix)\/[a-z0-9-]+$/
];

if (!patterns.some(regex => regex.test(branchName))) {
  console.error(`
    Invalid branch name: "${branchName}"
    Follow naming conventions like:
    - feature/login-page-PROJ-123
    - fix/button-color
    - release/1.2.0
  `);
  process.exit(1);
}

特殊场景处理

长期维护分支

对需要长期维护的旧版本分支，采用版本号明确标识：

support/v1.x
legacy/enterprise-edition

重构分支

大规模代码重构时建议单独标记：

refactor/auth-module
migration/webpack-to-vite

文档更新分支

纯文档修改可使用特定前缀：

docs/api-reference-update
changelog/2023-updates

命名反模式

应当避免的常见错误命名方式：

1. 使用作者姓名：

   johns-feature
   fix-by-mike
   

2. 含糊不清的描述：

   patch-1
   test-branch
   

3. 包含空格或特殊字符：

   my new feature
   bugfix@important
   

4. 全大写字母：

   FEATURE/NEW-UI
   HOTFIX/CRITICAL
   

跨团队协作实践

分布式团队应建立明确的命名规范文档，包含：

1. 前缀字典表
2. 事项追踪系统ID格式
3. 环境标识标准
4. 特殊分支处理流程

示例协作规范：

| 分支类型 | 前缀      | 示例                  |
|----------|-----------|-----------------------|
| 功能开发 | feature/  | feature/cart-flow     |
| 缺陷修复 | fix/      | fix/ios-crash-123     |
| 热修复   | hotfix/   | hotfix/auth-bypass    |
| 发布     | release/  | release/2.3.0         |