cat-xierluo/git-workflow

Git 全流程工作流

触发场景

• 分支创建、切换、管理
• 合并代码到 main（特别是 Monorepo 仓库）
• 创建、审查、合并 PR
• 解决合并冲突
• Git 操作前的安全检查

1. Git 安全协议

以下操作必须获得用户明确指示才能执行：

| 禁止操作 | 原因 | |:---------|:-----| | git push --force（特别是 main/master） | 覆盖他人提交 | | git reset --hard | 丢弃未提交的修改 | | git checkout . / git restore . | 丢弃工作区改动 | | git clean -f | 删除未跟踪文件 | | git branch -D | 强制删除分支 | | --no-verify 跳过 hooks | 绕过安全检查 | | --no-gpg-sign 跳过签名 | 绕过完整性验证 |

安全原则：

• 永远创建新 commit，而非 amend 已有 commit（除非用户明确要求）
• 暂存文件时，优先按文件名 git add <file> 而非 git add .
• 检测到 lock 文件时，先调查持有进程而非直接删除
• 遇到 pre-commit hook 失败时，修复问题后创建新 commit，不跳过 hook

2. 分支管理

创建新分支

# 从最新 main 创建
git checkout main && git pull origin main
git checkout -b <type>/<short-description>

# 命名规范
feat/add-ocr-support
fix/empty-description-retry
docs/update-readme
refactor/sync-logic

分支命名规范

分支名是远端协作和 PR 的公共标识，必须按任务语义命名，不按本地执行来源命名。不要在分支名前加 tmux-、subagent-、team-、agentteam- 等前缀；这些前缀属于本地 worktree 或 session 名称，由 parallel-agent-workflow 管理。

| 前缀 | 用途 | 示例 | |:-----|:-----|:-----| | feat/ | 新功能 | feat/batch-export | | fix/ | Bug 修复 | fix/null-pointer | | docs/ | 文档 | docs/api-guide | | research/ | 调研/素材 | research/issue-13-ch08-materials | | refactor/ | 重构 | refactor/parser | | chore/ | 杂项 | chore/update-deps |

推荐示例：

docs/ch01-agent-intro
research/issue-13-ch08-materials
fix/agent-session-shell

反例：

tmux-ch01
subagent-fix-copy
team-feature-a

分支清理

合并后的分支应及时删除：

# 删除本地分支
git branch -d <branch-name>

# 删除远程分支
git push origin --delete <branch-name>

Worktree（工作树）

当需要同时在多个分支上工作时，使用 worktree 避免频繁切换分支：

# 创建 worktree（自动创建新分支）
git worktree add ../pm-feature-ocr feat/ocr-support

# 在 worktree 中工作
cd ../pm-feature-ocr
# ... 编辑、提交 ...

# 完成后回到主工作目录
cd -

# 删除 worktree
git worktree remove ../pm-feature-ocr

# 查看所有 worktree
git worktree list

使用场景：

• 一个分支在跑耗时任务（训练/测试），同时需要在另一个分支工作
• 需要对比两个分支的代码
• Code review 时需要拉取 PR 分支到本地测试

注意事项：

• 同一分支不能同时被两个 worktree 检出
• worktree 中的修改是独立的，需要单独 push
• 删除 worktree 前确认已提交或推送改动

3. Monorepo 安全合并

核心规则

禁止 git merge 直接合并 feature 分支到 main。 Feature 分支若从旧 commit 创建，直接合并会误删所有不在分支里的文件。

正确做法：目录级 checkout

git checkout main && git pull origin main
git checkout <feature-branch> -- <skill-directory>/
git diff --cached --stat   # 确认只改了目标目录
git commit -m "feat(<skill>): 描述"

多 Skill 合并

涉及多个 Skill 时逐个目录 checkout，每个目录一个提交：

git checkout main && git pull origin main
git checkout <feature-branch> -- skill-a/
git diff --cached --stat
git commit -m "feat(skill-a): 描述"

git checkout <feature-branch> -- skill-b/
git diff --cached --stat
git commit -m "feat(skill-b): 描述"

合并后验证

git diff HEAD~1 --stat    # 确认无误删
ls .gitignore .env 2>/dev/null  # 确认关键文件还在

GitHub PR 合并

若用 GitHub PR 合并 Monorepo 中的某个 Skill 改动：

1. 先 rebase feature 分支到最新 main，确保 base commit 包含所有文件
2. 确认 PR diff 只涉及目标 Skill 目录
3. 使用 squash merge，commit 标题包含模块名和 PR 编号

# rebase feature 分支
git checkout <feature-branch>
git rebase origin/main
git push --force-with-lease  # rebase 后需要 force push

Rebase 冲突时的恢复

git pull --rebase 遇到冲突时，不要盲目接受远程的删除。Monorepo 中远程 PR 误删文件是常见情况。

判断原则：

1. 如果冲突是"远程删除 vs 本地修改"，先确认远程的删除是否是有意为之
2. 如果该 Skill 目录在远程 main 仍存在但被删除，很可能是合并误删，应保留本地版本
3. 如果确认是误删，用 git checkout <本地commit> -- <skill-directory>/ 恢复

恢复流程：

# 1. 先中止 rebase，回到安全状态
git rebase --abort

# 2. 获取 rebase 前的本地提交（通过 reflog）
git reflog | head -10

# 3. 从本地提交恢复被误删的目录
git checkout <本地commit-hash> -- <skill-directory>/

# 4. 单独提交恢复的文件
git diff --cached --stat   # 确认恢复的文件
git commit -m "feat(<skill>): 恢复被误删的文件"
git push origin main

关键：git reflog 保存了所有操作历史，即使 rebase 后本地提交也不会真正丢失。

4. PR 工作流

创建 PR

# 推送分支
git push -u origin <branch-name>

# 创建 PR
gh pr create \
  --title "feat(module): 简短描述" \
  --body "$(cat <<'EOF'
## 摘要
- 关键变更 1
- 关键变更 2

## 测试计划
- [ ] 验证项 1
- [ ] 验证项 2
EOF
)"

PR 正文最低要求

创建或审查 PR 时，正文至少包含：

| 区块 | 要求 | |------|------| | 摘要 | 说明改了什么，避免只有“update files” | | 测试计划 | 列出已运行或未能运行的验证；未运行要写原因 | | Agent 归属 | 若由 Agent 完成，写明 Agent ID、Git author、触发来源 | | 关联任务 | 关联 GitHub Issue、项目任务 ID 或用户指定任务 | | 风险 | 涉及迁移、删除、权限、安全、跨模块改动时说明风险和回退方式 |

缺失「摘要」或「测试计划」时，不应 approve；缺失「Agent 归属」时，要求补齐后再合并。

PR 标题格式

<类型>(<模块>): <描述>

与 commit 格式一致，多 Skill 仓库必须带模块名。

审查 PR

# 查看 PR 详情
gh pr view <number>

# 查看 PR 文件变更
gh pr diff <number>

# 提交 review
gh pr review <number> --approve --body "LGTM"
gh pr review <number> --request-changes --body "建议修改..."

合并 PR

合并默认采用 fail-closed 策略。只有在 diff 可读、review 结论明确、CI/checks 明确通过时，才允许自动或半自动合并。

合并前先做最小检查：

gh pr view <number> --json title,state,isDraft,mergeable,reviewDecision,headRefName,baseRefName
gh pr diff <number> --name-only
gh pr checks <number>

判断规则：

• state 不是 OPEN 或 isDraft 为 true：不合并
• mergeable 为 UNKNOWN / CONFLICTING / 空值：不合并，先更新分支或人工检查
• reviewDecision 为 CHANGES_REQUESTED，或应有 review 但没有明确通过：不合并
• gh pr checks 有失败、等待中、未知状态，或无法读取：不合并
• gh pr diff --name-only 显示跨模块污染、误删大量文件、敏感配置文件：不合并

Monorepo PR Diff 检查清单

对 Monorepo 或多 Skill 仓库，合并前必须检查文件范围：

gh pr diff <number> --name-only
gh pr diff <number> --stat

阻断条件：

• PR 声称只改一个模块，但 diff 涉及多个无关目录。
• 出现大量 deleted 或目录整体删除，且 PR 正文没有解释。
• 改动包含 .env、config/secrets.*、credentials.json、私钥或 token 文件。
• lockfile、schema、迁移文件、生成物变化无法对应到 Summary / Test plan。
• README.md、Marketplace 清单、版本号、CHANGELOG 中的版本不一致。

处理方式：要求拆 PR、缩小 diff、补说明或补测试。不要用“看起来问题不大”替代文件级检查。

# Squash merge（推荐）
gh pr merge <number> --squash \
  --subject "feat(module): 描述 (#<number>)" \
  --body "关键变更说明"

# Merge commit
gh pr merge <number> --merge

# Rebase merge
gh pr merge <number> --rebase

重要：通过 API 执行 squash merge 时，commit_title 不会自动追加 (#N)，必须手动写入。

本地拉取 PR 到 main 的提交格式

当用户要求“拉取 PR 到主分支 / 把 PR 拉进 main / 合入这个 PR”时，默认目标是让 main 历史中能直接看出来源 PR。不要用 git pull --ff-only origin pull/<N>/head 作为最终合入方式，因为 fast-forward 会保留 PR 原提交标题，通常不会显示 (#N)。

默认使用 squash commit 方式在 main 上生成一个带 PR 编号的提交：

# 1. 更新 main
git checkout main
git pull --ff-only origin main

# 2. 检查 PR 状态与 diff
gh pr view <N> --json title,state,isDraft,mergeable,reviewDecision,headRefName,baseRefName,url
gh pr diff <N> --name-only
gh pr checks <N>

# 3. 拉取 PR head 并 squash 到暂存区
git fetch origin pull/<N>/head
git merge --squash FETCH_HEAD
git diff --cached --stat

# 4. 使用 PR 标题 + PR 编号提交
git commit -m "<PR 标题> (#<N>)" \
  -m "PR: <PR URL>"

# 5. 推送 main，并关闭原 PR（若 GitHub 未自动标记 merged）
git push origin main
gh pr close <N> --comment "已通过提交 <sha> 合入 main。"

提交标题示例：

docs: 设定章节撰写默认使用 tmux Codex session (#7)
docs(ch01): 从 Chatbot 到 Agent (#10)
research(issue13): ch08 迭代解耦素材包 (#11)

若 PR 标题已经包含 (#<N>)，不要重复追加。若用户明确要求保留 PR 中多个原子 commit，不做 squash；但仍应提醒用户这种方式可能无法在每个 commit 标题中显示 PR 编号。

Fail-Closed 合并门禁

以下任一情况出现时，不得自动合并，必须停下并让人类确认或先修复信号来源：

| 阻断条件 | 处理 | |----------|------| | gh pr diff 失败、diff 为空或不可读 | 不 approve，不 merge；先确认分支和权限 | | CI/checks 失败、等待中、缺失或状态未知 | 不 merge；需要明确通过或用户显式确认 | | review 结论缺失、互相矛盾或只是摘要没有 verdict | 不 merge；补一次明确 review | | PR diff 超出声明范围，尤其是 Monorepo 误删文件 | 不 merge；先缩小 diff 或拆分 PR | | 分支保护、required checks、linked issue 状态不清楚 | 不 merge；先查清仓库规则 |

git-workflow 只维护这些 Git 安全规则；任务状态仍由 cross-agent-collab 和项目任务源管理，本地 Agent 会话由 parallel-agent-workflow 管理。

PR 状态检查

# 查看 CI 状态
gh pr checks <number>

# 查看所有 PR 列表
gh pr list --state open

PR 创建后立即跑 mergeable 检查（强制）

Agent 在 gh pr create 返回 PR URL 后，不要等用户/PM 拍板合并，立即跑一次完整状态检查，捕获 base 落后或 mergeable 冲突：

gh pr view <N> --json state,mergeable,mergeStateStatus,baseRefName,headRefName,files

判读规则：

| mergeable | mergeStateStatus | 含义 | 处理 | |---|---|---|---| | MERGEABLE | CLEAN | 可直接合并 | 进入 review → 合并流程 | | UNKNOWN | 空 | CI 还在跑或权限不足 | 等 CI / 确认权限后再查 | | CONFLICTING | DIRTY | 有内容冲突 | 不要直接 gh pr update-branch，按下方「base 落后 / 冲突处理决策表」选三选一方案 | | MERGEABLE | BLOCKED / BEHIND | base 落后但无内容冲突 | gh pr update-branch <N> 拉 base；如果失败再走决策表 |

base 落后 / 冲突处理决策表

当 PR 出现 base 落后、有冲突、或 update branch 失败时，按下表三选一：

| 情况 | 现象 | 推荐方案 | |---|---|---| | 冲突仅在 docs 同步文件（CHANGELOG / DECISIONS / TASKS） | git diff main..HEAD -- docs/ 显示 diff 是 docs 同步段（版本号、DEC 编号、ISS 任务卡进度） | 方案 A：本地 rebase + 解决冲突。接受 base 新内容，把 head 的 docs 段重新编号（如 DEC-026 → DEC-030）后 git rebase --continue；push 用 --force-with-lease。 | | 冲突在共享代码 / 实质代码 | git diff main..HEAD 涉及 src/ src-tauri/ src/shared/ 等多文件 | 方案 B：关掉 PR + 重建。gh pr close <N> --delete-branch；git switch -C <branch> origin/main；cherry-pick 实质代码 commit（跳过 docs 同步 commit）；重新写 docs 同步（使用最新 main 已占用的编号 +1）；push + new PR。 | | 冲突极少 / 1-2 个文件 | git diff main..HEAD 改动小且冲突集中 | 方案 C：GitHub PR UI 手动解决。在 PR 页面 "Resolve conflicts" → 编辑 → commit。 |

禁止 git push --force（不带 --force-with-lease），可能在远端已有他人 push 时覆盖。

来源：FaroPDF v0.1 Wave 1 根因复盘（PR #15 / #16 base 落后 + squash merge 内容冲突）。

PR 创建后：调起 doc-curator 体检

Agent 在 gh pr create 成功返回 PR URL 后，主动调起 doc-curator subagent 跑文档体检。

目的：在 PR 进入 review 前，发现当次变更是否引入文档膨胀、超出归档指针、违反硬性规则；如果有问题，由 doc-curator 在 PR 自身或单独的 maintenance PR 内修掉，不让膨胀项进入 main。

调用方式：

# 在 Agent 流程里，PR 创建完成后：
# 1. 调起 doc-curator subagent（项目级 Skill，自定义 Agent）
#    - 工作目录：仓库根
#    - 输入：刚 push 的 commit hash（可选）
#    - 期望输出：markdown 报告 + JSON 行

# 2. 解析报告（subagent 内部完成），按规则分支：
#    - 全部 ok → 不动作，继续 review 流程
#    - 软提示 → 把提示写入 PR 描述的"跟进事项"小节，不阻断
#    - 硬性 / 自适应告警 → 走 maintenance-pr.sh：
#      - 工作区干净 → 自动创建 chore/doc-curator-<date> 分支、提一个 maintenance PR
#      - 工作区不干净 → 仅报告，提示用户先清理

# 3. 不阻塞当前 PR：把 maintenance PR 链接追加到当前 PR 描述，让 review 知道"已发现 N 项"

约束：

• 这是 post-action 调起，不是 pre-PR 门禁（避免锁死 PR 创建流程）。
• doc-curator 不会改 src/ / src-tauri/ / tests/；改动仅限于 docs/ 维护类动作。
• doc-curator 不会写 CHANGELOG.md（CHANGELOG 由 release-workflow 维护）。
• 当前 PR 已 push 但 review 还没合并时，doc-curator 提的 maintenance PR 与当前 PR 并行存在；用户决定合并顺序。

PR 合并后：调起 doc-curator 体检

Agent 在 gh pr merge 成功（或 squash 推送 main 完成）后，主动调起 doc-curator subagent 跑一次完整体检。

目的：合并后文档库状态更新（新增 ISS 归档指针、DEC 编号推进、文件行数变化），基线可能漂移；及时发现新合并项是否引入膨胀，必要时自动提 maintenance PR。

调用方式：

# 在 Agent 流程里，PR 合并完成后：
# 1. 调起 doc-curator subagent 跑体检（项目级 Skill）
# 2. 解析报告：
#    - 全部 ok → 不动作，结束
#    - 软提示 → 报告给用户，不自动 PR
#    - 硬性 / 自适应告警 → 走 maintenance-pr.sh：
#      - 工作区干净 → 自动提 maintenance PR（按 doc-curator 协议）
#      - 工作区不干净 → 仅报告，让用户处理
# 3. 如果报告项触发了 state.json 的基线更新（adaptive 阈值漂移），下一次体检会按新基线判定

约束：

• 与"PR 创建后体检"互补：创建后体检关注"这次提交带来的变化"，合并后体检关注"main 整体健康度"。
• 合并后体检不阻塞合并动作：它发生在合并完成之后，只用于发现后续问题。
• 同一 PR 不重复触发两次（创建 + 合并各一次即可，不在中间 review 轮次再触发）。
• doc-curator 不会因为"发现 main 不健康"而尝试 revert 刚合入的 commit；它只做文档级维护，不动代码与决策。

总结：本 Skill 与 doc-curator 的关系

| 时机 | 谁调起 | 做什么 | 阻塞？ | |:-----|:-------|:-------|:-------| | gh pr create 成功 | 本 Skill（Agent 主动） | 调 doc-curator 体检本次变更 | 不阻塞，输出报告 + 可选 maintenance PR | | gh pr merge 成功 | 本 Skill（Agent 主动） | 调 doc-curator 体检 main | 不阻塞，输出报告 + 可选 maintenance PR | | 用户手动跑 scan.sh | 用户 | 体检 | 不阻塞 | | SessionEnd / pre-commit | — | 不在本 Skill 范围 | — |

git-workflow 只负责"什么时候调 doc-curator"，具体体检逻辑、维护动作、PR 生成全部由 doc-curator Skill 负责。两者通过 subagent 调起解耦：git-workflow 不直接执行文档 trim。

5. 合并冲突解决

检测冲突

# 尝试 merge，查看冲突文件
git merge <branch> --no-commit --no-ff
git diff --name-only --diff-filter=U   # 列出冲突文件

解决原则

1. 理解双方意图：阅读冲突标记两侧的代码，理解各自修改的目的
2. 优先保留双方：如果双方修改不矛盾，尽量都保留
3. 最小修改：只修改冲突区域，不要顺便重构
4. 验证：解决后运行编译/lint/测试

解决流程

# 1. 查看冲突文件列表
git diff --name-only --diff-filter=U

# 2. 逐个文件解决冲突
# 编辑文件，移除 <<<<<<< ======= >>>>>>> 标记

# 3. 标记为已解决
git add <resolved-file>

# 4. 验证
# 运行编译/lint/测试确保无破坏

# 5. 完成合并
git commit

lock 文件冲突

package-lock.json、pnpm-lock.yaml 等锁文件冲突时：

# 删除 lock 文件，重新生成
rm package-lock.json
npm install   # 或 pnpm install
git add package-lock.json

6. 常用 Git 操作速查

撤销与回退

# 撤销工作区修改（未 add）
git restore <file>

# 撤销暂存（已 add，未 commit）
git restore --staged <file>

# 查看某个文件的修改历史
git log --oneline -- <file>

# 查看某次 commit 的内容
git show <commit-hash>

暂存工作

git stash save "描述"
git stash list
git stash pop        # 恢复最近的 stash
git stash pop stash@{2}  # 恢复指定 stash

Cherry-pick

Cherry-pick 用于把某个已存在 commit 回补到当前分支。它容易把无关文件一起带入，必须先确认范围。

安全流程：

# 1. 工作区必须干净
git status --short

# 2. 先看 commit 内容和影响范围
git show --stat --oneline <commit-hash>

# 3. 回补完整 commit，并保留来源记录
git cherry-pick -x <commit-hash>

# 4. 回补后确认范围
git diff HEAD~1 --stat

Monorepo 或只需要部分文件时，不直接 cherry-pick 整个 commit，改用目录级提取：

git checkout <commit-hash> -- <directory>/
git diff --cached --stat
git commit -m "fix(<module>): 回补指定改动"

关键规则：

• 跨分支 backport 默认使用 git cherry-pick -x，保留来源 commit。
• 不直接 cherry-pick merge commit；确需处理时，必须明确父提交并使用 git cherry-pick -m <parent-number> -x <merge-commit>。
• 冲突后若范围变大、意图不清或出现跨模块污染，先 git cherry-pick --abort 回到安全状态。
• 冲突解决后必须重新查看 git diff --stat，确认只包含目标改动。
• 不把 cherry-pick 当作批量同步工具；多个无关 commit 应逐个处理和验证。

查看状态

git status
git log --oneline -20    # 最近 20 条
git diff --stat           # 概览变更文件
git blame <file>          # 查看每行的修改者
git remote prune origin   # 清理已不存在的远端 ref（合并后清理 stale ref）
git push origin --delete <stale-branch>  # 手动删某个远端分支

Tag 管理

git tag v1.0.0
git push origin v1.0.0
git tag -d v1.0.0        # 删除本地 tag
git push origin --delete v1.0.0  # 删除远程 tag

7. Issue 与 PR 命名规范

详细规范见 references/issue-pr-format.md，此处为速查。

本节只管理 GitHub Issue / PR 的命名和合并提交格式。项目常规任务状态、依赖和可领取判断仍由 cross-agent-collab 基于项目任务源维护。

Issue 格式

<类型>: <描述>

| 类型 | 示例 | |:-----|:-----| | feat | feat: skill-manager 支持版本检查 | | bug | bug: 解析空文件时崩溃 | | enhancement | enhancement: 添加批量导出 | | docs | docs: 更新使用说明 | | question | question: 能接入 xxx 吗 |

关闭时添加状态标记：[done]（自己）、[resolved]（外部）、[wontfix]、[duplicate]。

PR 格式

<类型>(<模块>): <描述>

多 Skill 仓库必须带模块名：

feat(skill-manager): 添加版本检查功能
fix(pdf-processor): 修复大文件解析崩溃
docs(litigation-analysis): 更新模板文档

PR 合并 Commit 格式

<类型>(<模块>): <描述> (#<PR编号>)

通过 API 执行 squash merge 时，commit_title 不会自动追加 (#N)，必须手动写入。

直接解决 Issue 的 Commit 格式

不是每个 Issue 都会通过“分支 + PR”解决。若用户要求直接在当前分支或 main 上修复/关闭某个 Issue，提交标题也必须显式带 Issue 编号，让 git log --oneline 能直接看出来源：

<类型>(<模块>): <描述> (#<Issue编号>)

提交正文用关闭关键字绑定 GitHub Issue：

Closes #<Issue编号>

- 关键变更 1
- 关键变更 2

示例：

docs: 清理过期待定事项 (#1)

Closes #1

- 删除过期决策记录
- 清理不再需要的待定项

如果编号来自项目本地任务源，而不是 GitHub Issue，不要使用 Closes #N 误关 GitHub Issue；改用正文标注：

Refs: project-task Issue #13

8. 提交规范

提交信息使用英文类型前缀 + 中文内容。每个 commit 必须有正文，不能只有标题。

与 git-batch-commit 的职责边界

git-batch-commit 是显式调用的提交快捷按钮，适合用户要求“git 提交 / 批量提交 / 拆分提交 / 整理提交”时，把已暂存变更按类型或模块拆成多个 commit。它可以把 GitHub Issue 写成标题后缀 (#N)，也可以在正文写 Refs #N 或本地任务引用。

git-workflow 是 Git 规则层，负责分支、PR、push、merge、安全门禁和 Issue 关闭语义。凡涉及“合并 PR”“拉 PR 到 main”“推送到远端”“关闭 Issue”“是否使用 Closes #N”，都以本 Skill 为准。

Commit 格式

<类型>: <标题>

- 关键变更 1
- 关键变更 2

支持类型

| 类型 | 用途 | |------|------| | docs | 文档变更 | | feat | 新功能 | | fix | Bug 修复 | | refactor | 代码重构 | | style | 代码风格变更 | | chore | 构建工具、依赖、工具链 | | test | 测试添加或修改 | | config | 配置变更 | | license | License 文件更新 |

多 Skill / 多模块规则

多 Skill 仓库必须在标题中写明模块名：

feat(skill-name): 添加批量导出

- 新增导出入口
- 补充参数校验

一次修改涉及多个独立 Skill 或模块时，应拆成多个 commit。每个 commit 只表达一个目的。

参考资源

• references/issue-pr-format.md — Issue 与 PR 命名详细规范
• references/gh-cli-quickref.md — gh CLI 常用命令速查
• TASKS.md — 本 Skill 的维护任务和后续上下文