Zhuozhuocrayon AI Workspace Code Review

Code Review

0x01 定位

code-review 负责审查 PR 或代码变更的正确性、兼容性、可维护性与发布风险。

默认只在对话中输出 review 草稿，不发布到 PR。

GitHub 写操作必须得到用户明确授权，包括评论、approve、request changes 和 dismiss review。

唯一例外：用户触发 review 后，针对已确认修复的既有未解决 review thread，可以自动 resolve。

0x02 权限门禁

a. GitHub 写操作

用户明确说以下意图时，才执行对应 GitHub 写操作：

授权模糊时必须先确认，不得猜测执行。

b. Assignees

PR review 场景开始前必须补齐 assignees，未完成前不得继续 review 或执行 GitHub 写操作。

1. gh api user --jq .login 获取当前登录用户。
2. gh pr view <pr> --json author --jq .author.login 获取 PR 作者。
3. 去重后执行 gh pr edit <pr> --add-assignee <login>。
4. 执行 gh pr view <pr> --json assignees --jq '.assignees[].login' 校验。

失败时停止并告知用户，等待用户决策后再继续。

0x03 上下文收集

开始审查前，必须同时建立项目规范、变更内容和历史评论三类上下文。

不要只看 diff 片段就下结论。

0x04 审查重心

优先关注会影响合入安全的问题，再评估长期可维护性。

a. 合入安全

b. 可维护性

0x05 输出草稿

用户说 review、复查、代码审查 等时，先输出对话草稿报告。

报告固定包含：

1. 汇总评论：整体结论、风险点、是否建议合入。
2. 新增问题：本轮新发现的问题，按 P0 / P1 / P2 排序。
3. 已存在未解决 review 线程的解决情况：用表格输出。

既有线程表格至少包含 评论 / 线程、位置、状态、处理动作、证据。

状态值固定为 已修复、未修复、待确认。

0x06 线程收口

用户触发 review 后，完成逐项核对的既有未解决 review thread 可以自动处理。

不对本轮新增评论自动 resolve。

用户明确要求不自动 resolve 时，遵循用户要求。

0x07 评论规范

a. 严重程度

严重程度顺序固定为 P0 > P1 > P2。

b. 发布位置

可定位到文件与行号的问题，必须优先发布 inline review comment。

仅当问题无法定位到单行，或工具限制无法 inline 时，退化为 conversation 评论，并注明 path:line 与退化原因。

行内评论格式：

**`path/to/file.go:42`** [P1]
> return nil

问题：错误返回值未处理，可能导致空指针。

评论内容结构：

• 必须包含明确问题、影响范围和修复方向。
• 当对话中已经确认结构代码或关键实现形态时，PR 评论必须保留这些结构信号。
• 不要把已确认的结构方案压缩成泛化建议，导致作者无法直接落代码。

Bad：

[P1] 问题：错误来源应该做并集展示。这里发现已有 exception event 就直接返回，会让同一个 span 中已经上报的标准 exception event 和 attributes.rpc.error_code / attributes.trpc.status_code 变成互斥关系；后续 get_exception_events() 只会看到原始 events，无法再补充返回码逻辑异常，错误列表、详情和接口分布都会漏掉这类返回码错误。

建议：去掉这个早退，保留已有 events，并在存在 RPC/tRPC 错误码时额外 append 一个返回码 exception event。核心逻辑可以保持很简单：events = span.get(OtlpKey.EVENTS) or [] 后写回 span[OtlpKey.EVENTS] = events，然后沿用下面的返回码提取逻辑。这里 if code is None or code == "": 建议保留，并补一句注释说明不要写成 if not code，避免数值型错误码 0 被误判为空。

Good：

[P1] 问题：错误来源应该做并集展示。当前已有 `exception` event 就直接 `return span`，会让已上报 events 和 RPC/tRPC 返回码逻辑异常变成互斥关系；同一个 span 同时包含两类错误来源时，返回码错误不会进入后续 `get_exception_events()`。

建议：去掉早退，保留已有 events，并在命中 RPC/tRPC 错误码时额外 append 返回码 `exception` event：

~~~python
events: list[dict[str, Any]] = span.get(OtlpKey.EVENTS) or []
span[OtlpKey.EVENTS] = events

attributes: dict[str, Any] = span.get(OtlpKey.ATTRIBUTES) or {}
status_message: str = (span.get(OtlpKey.STATUS) or {}).get("message", "")

for code_field, message_field in cls.RPC_EXCEPTION_FIELDS.items():
    code: Any | None = attributes.get(code_field)
    # 不使用 `if not code`，避免数值型错误码 0 被误判为空。
    if code is None or code == "":
        continue

    ...
~~~

c. 评论语言

目标项目 language 字段从 repos.json、private/repos.json 读取。

0x08 交付自检

• 新增问题必须以风险为主，不把风格偏好伪装成阻塞问题。
• 每个 finding 都要有代码位置、影响说明和修复方向。
• 没有发现问题时，明确说明未发现阻塞问题，并列出残余风险或未覆盖检查。
• 发布到 PR 的评论必须和用户最终确认的草稿完全一致。
• 发布前逐条比对最终草稿，禁止在发布时二次改写、压缩、补充或删减。
• 发布到 PR 前再次确认 inline 评论、总结评论和语言选择。
• 关联方案的 review，必须完成方案回写核对：版本锚点是否登记本次 PR / 分支 / 状态，以及实现与方案是否存在实质出入，缺口在草稿中给出同步或询问动作。

0x09 方案回写

review 是方案与现实对齐的关键契机，关联方案时按 knowledge-mgr 技能的方案写作与回写规范落实结论。

本 skill 只在此阶段触发核对、产出差异，不锚定其具体规则，规范遗忘时召回 knowledge-mgr 补读。

约束：

• 缺陷类偏离按 0x04 审查重心 走 P1，不回写方案。
• 不擅自重写方案：先在草稿给出核对 / 差异与拟改要点，经用户确认或明确指令后再回写。
• 回写按 knowledge-mgr 的方案规范执行，GitHub 写操作仍遵循 0x02 权限门禁。

Source: ZhuoZhuoCrayon/ai-workspace — distributed by TomeVault.