Zc Bug Fix

Bug-Fix 用户优先分阶段执行协议

本 skill 采用“用户指定优先、前置条件按需补齐”的分阶段流程。 如果用户明确要求“从阶段 4 开始”或“从某个阶段继续”，就从该阶段执行；不要因为固定流程强制退回阶段 0。真正的安全前置条件（保护分支、MR 前禁止回写禅道、bug_type 通过 browser 字段写入等）仍然必须满足。

⛔ 全局禁令（违反任何一条即为严重错误）

Python 与操作系统入口

脚本要求 Python 3.8–3.12，只依赖标准库。先选择一个可用解释器，后续全程复用：

1. 解析本 skill 的绝对目录和 scripts/bugfix_flow.py 绝对路径。
2. 路径始终作为带引号的独立参数传入。
3. 下文用 <RUNNER> 表示“已验证的 Python 启动器 + 主控脚本绝对路径”，不是要原样输入的文字。
4. 解释器低于 Python 3.8 时停止，不尝试运行。

启动总则（用户优先）

1. 用户明确说“从阶段 N 开始 / 从阶段 N 继续” → 直接从阶段 N 开始。 前面阶段只做必要补位，不做仪式化重跑。
2. 用户说明“代码已经改好了 / bug 已经处理了”但没说阶段 → 先分析当前工作区修改、已暂存内容、分支状态、已有 Issue/MR/禅道信息，再从最接近的阶段继续。 这类场景通常优先考虑阶段 4。
3. 只在当前阶段缺少关键信息时再提问。 例如当前阶段需要 bug_id / 禅道链接，而上下文里没有时，再向用户索要；不要一上来把阶段 0→3 全部重跑。
4. 用户明确要求进入阶段 4 / 5 / 6 / 7，可视为对该阶段动作的授权。 不要针对同一动作重复索要“是否允许创建分支 / 提交 / 推送 / 建 MR”。
5. 真正的硬前置条件不能跳过。 尤其阶段 7 之前，必须有验证结果、远程分支、ISSUE_URL、MR_URL。

阶段 0: 按需检查配置

只有当当前或下一步需要访问禅道 / GitLab 时才执行本阶段。

• fetch
• create-issue
• create-mr
• zentao-writeback
• 备用的 zentao-confirm / zentao-set-browser-type / zentao-resolve

如果用户从阶段 4 开始，且当前只需要分析现有改动、创建分支、提交、推送，可暂不执行本阶段。

执行：

<RUNNER> check-config

如果输出 CONFIG_OK： 进入阶段 1。 如果输出 MISSING_CONFIG 或 MISSING_FIELD： ⛔ 立即停止，告知用户创建配置文件：

<RUNNER> init-config

然后编辑脚本返回的配置文件绝对路径，填入实际的禅道/GitLab 信息。

⛔ 配置不完整时，禁止执行依赖配置的后续阶段。

阶段 1: 读取禅道 Bug

仅在需要补齐 Bug 背景或缺少 bug_id / 禅道链接时执行。

• 如果用户已经提供了足够的 Bug 信息，或当前从阶段 4 / 5 / 6 / 7 继续且所需信息已齐，可以不回头强制执行本阶段。
• 如果当前阶段需要引用禅道 Bug，但上下文里没有 bug_id 或禅道链接，先向用户索要，再继续。

执行：

<RUNNER> fetch <bug_id>

必须从返回的 JSON 中提取以下信息：

• Bug 标题、严重程度、优先级
• 环境信息（版本、硬件）
• 重现步骤
• 期望结果 vs 实际结果
• 日志/报文（如有）
• 相关人员：报告人（openedBy）、定位人、验证人

同时完成 Bug 根因分类预判： 阅读 Bug 内容后，从下方分类表选择一个最贴近根因的中文分类名。低置信度且准备进入阶段 7 前，才需要向用户补确认。此分类将在阶段 7 通过脚本写入禅道 browser 字段。

允许的分类（必须精确匹配）：

⛔ 禁止选择：空值、继承或历史遗留、未明确定位、非问题。 ⛔ bug_type 不是评论内容 — 是一个用于写入 browser 字段的分类标签。

检查点： 向用户报告 Bug 摘要和预判分类，确认理解正确后进入阶段 2。

阶段 2: 分析并修复代码

要求：

1. 搜索定位相关代码
2. 先读文件再修改 — 禁止盲改
3. 只修改与当前 Bug 直接相关的代码
4. 所有新增/修改的函数必须补中文注释
5. 必须保证编译通过，且修改的代码静态检查无新警告

如果用户已经改好了代码并要求从阶段 4 或更后阶段继续：

1. 不要强制回到“重新修复代码”的流程。
2. 先分析当前工作区 / 已暂存改动（git status、git diff、git diff --cached）。
3. 提炼修改文件、根因、修复思路、潜在影响，作为阶段 4 / 5 / 6 的输入。
4. 如果发现明显与当前 Bug 无关的改动，提醒用户并在阶段 4 只提交相关文件。

⛔ 本阶段禁止创建分支、推送代码、操作禅道。

检查点： 修改完成后，列出所有改动文件和修改摘要；如果用户已经明确要求继续推进，不必在这里停住等待。

阶段 3: 按需自测验证

如果用户明确要求从阶段 4 开始，不要机械退回阶段 0；优先利用用户已提供的验证结果。只有在准备进入阶段 7 / 8，或你无法说明验证结果时，才补做必要自测。

建议按以下顺序补齐验证证据：

1. 扫描代码库（包含 .test 等隐藏目录），识别项目真实使用的构建与测试入口，再运行相关用例。不要使用吞掉失败结果的伪通用命令。
2. 如果有类似 meter-protocol-serial 的串口通讯skill，必须根据修改的内容，发送、读取相关协议报文进行自测验证，后续把自测的相关报文附加到议题中。

⛔ 如果当前目标是进入阶段 7 / 8，验证未全部通过时必须返回阶段 2 修复。

检查点： 向用户报告自测验证结果；如果用户已经明确要求继续推进，可直接进入阶段 4，但进入阶段 7 / 8 前必须能说明验证结果。

阶段 4: 创建分支 + 提交 + 推送

⛔ 必须有用户明确意图才能执行本阶段。 用户直接说“从阶段 4 开始”或“帮我提交并推送”或“BUG已经改完了，从后面的阶段开始”即可视为已授权且从该阶段直接开始，不要重复追问。

4.0 如果代码已经存在，先分析当前修改：

1. 查看 git status --short
2. 查看 git diff --stat、git diff、git diff --cached
3. 提炼修改文件、根因、修复思路、验证摘要
4. 确认本次提交只包含与当前 Bug 直接相关的改动

如果缺少 bug_id 或禅道链接： 先向用户索要。分支名、提交信息、Issue/MR 模板都依赖它。

4.1 创建 bugfix 分支（脚本自动从 develop 创建）：

<RUNNER> create-branch <bug_id> <short-desc>

分支名格式：bugfix/<bug_id>-<short-desc>

4.2 提交代码（只提交相关文件）：

git add <file1> <file2> ...
git commit -m "fix(bug#<bug_id>): <简要描述问题和修复方案>"

⛔ 禁止 git add . 或 git add -A。只添加与本次修复相关的文件。 ⛔ 禁止在 develop/main/master 上 commit。脚本会拒绝。

4.3 推送分支（脚本自动拒绝推送到保护分支）：

<RUNNER> push-branch

检查点： 确认远程分支已创建。记住分支名，阶段 6 需要用。

阶段 5: 创建 GitLab Issue

如果用户明确要求从阶段 5 开始，即视为允许创建 Issue；不要再重复询问。若缺少禅道链接 / bug_id，先向用户索要，因为模板必须引用它。

5.1 准备 Issue 内容： 使用跨平台命令复制模板到系统临时目录：

<RUNNER> prepare-description issue <bug_id>

记录脚本返回的绝对路径，用编辑工具填写完整 6D 内容。不要把描述直接拼进命令行。

Issue 必须至少包含：

1. 禅道链接
2. Bug 描述（环境、步骤、期望、实际、日志）
3. 根因分析（根因、直接原因、代码位置、为什么没发现、检讨）
4. 解决方案（思路、修改点、理由、副作用评估）
5. 验证结果
6. 黑盒测试建议
7. 后续改进
8. 责任人

5.2 创建 Issue：

<RUNNER> create-issue <bug_id> "<阶段 5.1 返回的绝对路径>" "bug,<标签>"

检查点： 从脚本输出的 JSON 中提取 web_url 字段，保存为 ISSUE_URL。阶段 7 必须使用。 格式形如：http://172.17.0.100:8080/<group>/<project>/-/issues/<number>

阶段 6: 创建 GitLab MR

如果用户明确要求从阶段 6 开始，即视为允许创建 MR；不要再重复询问。MR 描述中的修复内容、根因、修改文件、验证结果应优先复用前面已分析好的信息，而不是重新回退到阶段 0。

6.1 准备 MR 描述： 使用跨平台命令复制模板到系统临时目录：

<RUNNER> prepare-description mr <bug_id>

记录脚本返回的绝对路径，用编辑工具填写 MR 描述。

MR 描述必须包含：修复内容、根因、修改文件、验证结果、禅道链接、Issue 链接、责任人。

6.2 创建 MR：

<RUNNER> create-mr <bug_id> "bugfix/<bug_id>-<short-desc>" "<阶段 6.1 返回的绝对路径>"

检查点： 从脚本输出的 JSON 中提取 web_url 字段，保存为 MR_URL。阶段 7 必须使用。 格式形如：http://172.17.0.100:8080/<group>/<project>/-/merge_requests/<number>

阶段 7: 回写禅道（一条命令完成全部操作）

如果用户直接要求从阶段 7 开始，可以直接准备本阶段；但只补齐本阶段缺少的关键信息，不要为了“走流程”回头重跑无关阶段。

⛔ 前置条件（全部满足才能执行）：

• ✅ 阶段 3 验证已通过
• ✅ 阶段 4 代码已 push 到远程
• ✅ 阶段 5 已创建 Issue，有 ISSUE_URL
• ✅ 阶段 6 已创建 MR，有 MR_URL
• 缺少任何一项，⛔ 禁止执行本阶段

回写状态决策（脚本和执行者都必须遵守）

browser 存储的是分类编码，不是字面分类名。每次判断必须严格执行：

目标中文分类 → 目标编码 → 当前 browser，最后只比较两个编码。

禁止拿 chrome 与中文分类名直接比较。browser='chrome' 就表示 设计_算法设计问题，不是浏览器信息，也不是未分类。

完成编码比较后，生命周期只有以下动作：

终态分类冲突会结束本次自动化。不得自动编辑、不得再次解决，也不得建议“会后再自动编辑分类”；只有用户完成独立人工判断并发起新的明确指令后，才能处理。

错误推理红旗：

• “chrome 和 设计_算法设计问题 字符串不同，所以要重写分类” → 错，必须先映射为编码。
• “分类编辑后若重回 active，再点一次解决即可恢复” → 错，禁止对终态 Bug 自动编辑。
• “经理要求再点一次，重复操作更保险” → 错，终态或已完成动作必须跳过。
• “旧脚本打印完成，HTML alert(...) 可以忽略” → 错，立即停止，回读失败不得继续解决。

使用一条命令完成幂等禅道回写：

<RUNNER> zentao-writeback <bug_id> "<bug_type>" "<ISSUE_URL>" "<MR_URL>"

这条命令会自动完成以下五步：

1. ✅ 检查 Bug 当前状态（避免重复操作）
2. ✅ 仅在 active 且未确认时确认 Bug，评论附带 Issue 可点击链接
3. ✅ 仅在 active 且分类不同时设置 browser 字段
4. ✅ 仅在仍为 active 时解决 Bug，评论附带 MR 可点击链接
5. ✅ 回读并校验最终状态、确认标志和分类编码

参数说明：

⛔ 四个参数全部必填 — 脚本会拒绝不完整的调用 ⛔ 严禁手动拼接禅道 API 调用来替代本命令 ⛔ 严禁把 bug_type 写入评论 — 它通过脚本写入 browser 字段 ⛔ 重复调用只能用于幂等续跑，不能用于试验参数或验证猜想

最终后置条件

只有脚本最终回读同时满足以下三项，才允许输出 ✅ 禅道回写完成：

1. status 为 resolved 或 closed
2. confirmed 表示已确认
3. browser 等于目标分类编码

任一项不满足都视为失败。查看只读状态后再决定是否使用单个备用命令，禁止把三个备用命令整套重跑。

阶段 8: 总结报告

向用户输出最终总结表格：

附上需要硬件/协议人工验证的测试场景表。

备用命令（仅补齐明确缺失的单个动作）

先执行只读检查：

<RUNNER> fetch <bug_id>

根据回读结果只选择一个仍缺失的动作：

# 1. 确认 Bug（评论必须包含 Issue URL）
<RUNNER> zentao-confirm <bug_id> "已创建 GitLab issue: <ISSUE_URL>"

# 2. 设置 browser 字段（传中文分类名，不是写评论！）
<RUNNER> zentao-set-browser-type <bug_id> "<bug_type>"

# 3. 解决 Bug（分类已经正确且状态仍为 active 时才执行）
<RUNNER> zentao-resolve <bug_id> "已创建 GitLab MR: <MR_URL>" ""

• 分类已经正确：禁止执行第 2 项。
• 状态已经是 resolved / closed：禁止执行第 3 项。
• 终态分类冲突：三个备用命令都不能执行，停止并人工确认。
• 任一备用动作完成后重新 fetch；满足最终后置条件即停止。

配置说明

配置文件位于项目根目录 zc-bug-fix.config。 环境变量 ZC_BUG_FIX_CONFIG 可覆盖路径（相对路径按项目根目录解析）。

必填字段：

初始化：

<RUNNER> init-config

文件结构

zc-bug-fix/
├── SKILL.md                          ← 本文件（用户优先协议）
├── zc-bug-fix.config.example         ← 配置模板
├── scripts/
│   ├── bugfix_flow.py                ← 主控脚本（优先使用）
│   ├── check_config.py               ← 配置检查
│   ├── config_paths.py               ← 路径解析
│   ├── zentao.py                     ← 禅道 API
│   └── gitlab.py                     ← GitLab API
├── templates/
│   ├── issue_6d_template.md          ← Issue 6D 模板
│   └── mr_template.md                ← MR 描述模板
└── tests/
    ├── test_config_paths.py          ← 配置、映射与 URL 测试
    ├── test_cross_platform_helpers.py ← 跨平台辅助命令测试
    ├── test_zentao_state_machine.py  ← 禅道幂等状态机测试
    └── test_skill_contract.py        ← skill 安全契约测试