Git 与代码规范实践指南

一、分支命名规范

保持分支名称简洁且语义明确：

• 修复 bug：fix_xxxx
• 新功能：feat_xxxx
• 代码重构：ref_xxxx

示例：

• fix_login_error - 修复登录错误
• feat_payment_module - 新增支付模块
• ref_user_service - 重构用户服务

二、代码提交规范

提交信息格式

【类型】主题内容

• 类型：必填，描述修改类型
• 主题内容：必填，说明修改原因、内容和思路

类型取值

• feat：新特性
• fix：修改 bug
• refactor：代码重构
• docs：文档更新
• style：代码格式修改
• test：测试用例修改
• chore：构建过程或辅助工具变动
• perf：性能优化

提交示例

fix: 修复空指针BUG
feat: 新增商户订单列表查询接口
refactor: 优化用户查询逻辑，提升响应速度
docs: 更新API接口文档

三、代码注释规范

1. 函数注释

复杂逻辑添加注释，说明函数用途、参数含义和返回值：

/**
 * 计算订单折扣价格
 * @param {number} originalPrice - 原始价格
 * @param {number} discountRate - 折扣率(0-1)
 * @return {number} 折扣后价格
 */
function calculateDiscount(originalPrice, discountRate) {
  // 复杂计算逻辑说明...
}

2. TODO 注释

标记待完成的功能，包含负责人姓名：

// TODO: [张三] 添加参数校验逻辑
// TODO: [李四] 接入第三方支付接口

3. FIXME 注释

标记已知问题，需要后续修复：

// FIXME: 高并发场景下可能出现数据不一致
// FIXME: 这里的异常处理需要优化

四、分支管理策略

简化版 Git Flow

main/master (生产环境)
  └── develop (开发环境)
       └── feature/fix分支 (个人开发)

操作流程

1. 从 develop 拉取新分支进行开发
2. 开发完成后合并到 develop
3. develop 测试通过后合并到 main
4. 紧急修复可从 main 拉 hotfix 分支

## 五、常见问题处理

### 1. 提交信息写错了
```bash
# 修改最近一次提交信息
git commit --amend -m "正确的提交信息"

# 修改多次提交信息
git rebase -i HEAD~3

2. 代码冲突解决

# 拉取最新代码
git pull origin develop

# 解决冲突后
git add .
git commit -m "fix: 解决合并冲突"