git-workflow-guide

Git 工作流程指南

语言: English | 简体中文

版本: 1.0.0 最後更新: 2025-12-24 適用範圍: Claude Code Skills

目的

本技能提供 Git 分支策略、分支命名慣例与合併操作的指導。

快速參考

工作流程策略选择

分支命名慣例

<type>/<short-description>

命名規則

1. 使用小写
2. 使用連字号分隔单字
3. 描述性但簡潔

详细指南

完整标准請參阅：

• Git 工作流程策略
• 分支命名參考

建立分支前检查清单

建立新分支前：

1. 检查未合併的分支

   git branch --no-merged main
   

2. 同步最新程序码

   git checkout main
   git pull origin main
   

3. 验证测试通過

   npm test  # 或您项目的测试指令
   

4. 使用正确命名建立分支

   git checkout -b feature/description
   

合併策略快速指南

範例

建立功能分支

# 良好範例
git checkout -b feature/user-authentication
git checkout -b fix/null-pointer-in-payment
git checkout -b hotfix/critical-data-loss

# 不良範例
git checkout -b 123              # 缺乏描述性
git checkout -b Fix-Bug          # 非小写
git checkout -b myFeature        # 缺少类型前綴

合併工作流程 (GitHub Flow)

# 1. 從 main 建立分支
git checkout main
git pull origin main
git checkout -b feature/user-profile

# 2. 进行变更并提交
git add .
git commit -m "feat(profile): add avatar upload"
git push -u origin feature/user-profile

# 3. 透過 GitHub/GitLab UI 建立 PR 并合併

# 4. 合併後刪除分支
git checkout main
git pull origin main
git branch -d feature/user-profile

处理合併衝突

# 1. 使用 main 更新您的分支
git checkout feature/my-feature
git fetch origin
git merge origin/main

# 2. 在文件中解决衝突
# <<<<<<< HEAD
# 您的变更
# =======
# 传入的变更
# >>>>>>> origin/main

# 3. 暫存已解决的文件
git add resolved-file.js

# 4. 完成合併
git commit -m "chore: resolve merge conflicts with main"

# 5. 测试并推送
npm test
git push origin feature/my-feature

組態偵测

本技能支援项目特定的工作流程組態。

偵测順序

1. 检查 CONTRIBUTING.md 是否有「Git Workflow」或「Branching Strategy」章节
2. 若找到，使用指定的策略（GitFlow / GitHub Flow / Trunk-Based）
3. 若未找到，预设使用 GitHub Flow 以保持簡单

首次设置

若未找到組態：

1. 詢問使用者：「本项目尚未设置 Git 工作流程策略。您偏好哪一种？（GitFlow / GitHub Flow / Trunk-Based）」
2. 选择後，建议在 CONTRIBUTING.md 中记录：

## Git 工作流程

### 分支策略
本项目使用 **[所選选项]**。

### 分支命名
格式：`<type>/<description>`
範例：`feature/oauth-login`、`fix/memory-leak`

### 合併策略
- 功能分支：**[Squash / Merge commit / Rebase]**

相关标准

• Git 工作流程
• 提交消息指南
• 簽入标准

版本历史

授权

本技能採用 CC BY 4.0 授权發布。

來源：universal-dev-standards