Vancebs Skills Code Review

Code Review Skill

功能： 按需 Code Review。收到 Gerrit 变更信息时，通过 gerrit-api skill 获取 patch，按 T2MCodingRule 审查，生成报告。不对 Gerrit 做任何写操作。

触发条件（收到以下任意内容时使用本 skill）：

• Gerrit 变更页面链接（http://... 或 https://...）
• Change number（纯数字，如 12345）
• Change-Id（I + 40 位十六进制，如 Iabcdef...，正则：^I[0-9a-f]{40}$）
• Commit SHA（7~40 位十六进制，正则：^[0-9a-f]{7,40}$）
• Gerrit stream event JSON 文本

所有 Gerrit 操作均通过 gerrit-api skill 完成，本 skill 不直接调用 Gerrit API。

路径约定: scripts/... 路径均相对于 code-review Skill 目录（.agents/skills/code-review/）。
gerrit-api 脚本路径通过变量 GERRIT_API_SKILL_DIR 引用，默认为 .agents/skills/gerrit-api（OpenClaw 标准安装路径）。

# OpenClaw 中 gerrit-api 的默认安装路径（通常已由平台自动设置）
GERRIT_API_SKILL_DIR="${GERRIT_API_SKILL_DIR:-.agents/skills/gerrit-api}"

Step 1 — 环境检查（首次加载 skill 时运行一次）

python3 scripts/check_env.py

脚本检查：Python 版本、gerrit-api 已安装、T2MCodingRule 已安装、Gerrit 环境变量已设置。

如果 gerrit-api 或 T2MCodingRule 未安装，脚本会输出安装命令：

❌ gerrit-api skill 未安装（必须安装）
   安装命令: npx skills add https://github.com/vancebs/skills --skill gerrit-api
❌ T2MCodingRule skill 未安装（必须安装）
   安装命令: npx skills add https://github.com/vancebs/skills --skill T2MCodingRule

Step 2 — Configure (optional)

配置字段（可选）：

Option A — Config file

Create $WORKSPACE/.config/code-review.json (or ~/.config/code-review.json):

{
  "CODE_REVIEW_SKIP_PATTERNS": "*.min.js,*.generated.*"
}

Option B — Environment variables

export CODE_REVIEW_SKIP_PATTERNS="*.min.js,*.generated.*"

Dependencies

📋 工作流（收到 Gerrit 变更信息时执行）

flowchart TD
    A([收到 Gerrit 变更信息]) --> B[Step 1: 解析输入，提取 change_number]
    B --> C{能识别类型?}
    C -- 否 --> D[提示用户提供 change number 或 URL]
    C -- 是 --> E[Step 2: 用 gerrit-api 获取变更详情]
    E --> F[Step 3: 用 gerrit-api 列出文件]
    F --> G[Step 4: 用 gerrit-api 逐文件获取 diff]
    G --> H[Step 5: 加载 T2MCodingRule，审查 diff]
    H --> I[Step 6: 生成并输出报告]
    I --> M([结束])
    D --> M

阶段一 — 解析输入，提取 change_number

根据收到的信息类型，提取 change_number（Gerrit 变更的数字 ID）：

URL 提取示例：

https://gerrit.example.com/c/platform/frameworks/base/+/12345      → 12345
https://gerrit.example.com/c/platform/frameworks/base/+/12345/2    → 12345（patchset 2）
https://gerrit.example.com/#/c/12345/                              → 12345

通过 Change-Id 查询 change number：

python3 "$GERRIT_API_SKILL_DIR/scripts/gerrit_api.py" \
  query "change:Iabcdef1234567890abcdef1234567890abcdef12+limit:1"

通过 commit SHA 查询 change number：

python3 "$GERRIT_API_SKILL_DIR/scripts/gerrit_api.py" \
  query "commit:abc123def456+limit:1"

阶段二 — 通过 gerrit-api 获取 Patch 数据

以下命令全部使用 gerrit-api skill 的脚本（路径: $GERRIT_API_SKILL_DIR/scripts/）。

2A — 获取变更详情

python3 "$GERRIT_API_SKILL_DIR/scripts/gerrit_api.py" get-change <change_number>

从输出中提取：

• subject — 提交标题
• project — 项目名
• branch — 目标分支
• owner.username 或 owner.name — 提交者
• current_revision — 当前 patchset 的 commit SHA（后续步骤需要）

2B — 列出变更文件

python3 "$GERRIT_API_SKILL_DIR/scripts/gerrit_api.py" list-files <change_number>

输出为文件路径列表。跳过以下文件（对应 skip_file_patterns 配置）：

• 配置文件（如 *.json, *.xml, *.yaml）按 skip_file_patterns 跳过

2C — 获取每个文件的 Diff

对 list-files 返回的每个文件路径执行：

python3 "$GERRIT_API_SKILL_DIR/scripts/gerrit_api.py" \
  get-diff <change_number> "path/to/file.java"

Windows 将 python3 替换为 python，路径分隔符用 %：

python "%GERRIT_API_SKILL_DIR%\scripts\gerrit_api.py" get-diff <change_number> "path/to/file.java"  :: OpenClaw standard path

收集所有文件的 diff 后，进入阶段三。

阶段三 — Code Review（对所有收集到的 diff）

加载 T2MCodingRule skill，按以下步骤审查。

Checklist: 审查前准备

• get-change 已成功，已知 subject、project、branch、current_revision
• list-files 已返回文件列表（过滤掉 skip_file_patterns 中的文件）
• 所有文件的 get-diff 已完成
• T2MCodingRule skill 已加载

3A — 提交信息（Commit Message）审查

依据 T2MCodingRule 一、Git Commit Message 规范逐条检查：

注意： get-change 返回的 subject 字段仅为首行。如需检查完整 commit message，可在报告中注明"无法获取完整 message"并仅基于 subject 审查 CM-1 ~ CM-3。

3B — 文件 Diff 审查

只审查 diff 中新增/修改的行（+ 开头的行），根据扩展名选择规范：

审查重点：

• 命名规范（类/变量/函数）
• 注释完整性（公共 API、复杂逻辑）
• 安全规范（T2MCodingRule 七）：无硬编码密码、日志无敏感信息
• 兼容性规范（T2MCodingRule 八）：无废弃 API、接口向后兼容
• 逻辑错误、资源泄漏、死锁风险

3C — 问题定级与 PASS/FAIL 判断

判断： 有任意 🔴 或 🟠 → FAIL，否则 PASS。

3D — 生成报告（固定格式）

⚠️ 严格按以下格式输出报告，不允许附加任何格式外的内容（无引言、无总结、无 markdown 代码块包裹）。

**PASS** 或 **FAIL**

| 级别 | 文件 | 问题 |
|---|---|---|
| 🔴 CRITICAL | {file}:{line} | [{编号}] {一句话描述，≤30字} |
| 🟠 ERROR | commit-message:1 | [CM-1] 首行缺少有效 Issue Key |
| 🟡 WARNING | {file}:{line} | [{编号}] {描述，≤30字} |
| 🔵 INFO | {file}:{line} | {描述，≤30字} |

# Patch信息
URL: {gerrit_url}/c/{project}/+/{change_number}
Change-Id: {change_id}
Owner: {owner_email}
Repo: {project}
Branch: {branch}

# 问题清单
## {file_path}:{line}
[{级别}] [{编号}]{问题描述}
- **原因:** {违反的规范条目及理由}
- **建议:** {具体修改建议}

格式规则（严格执行）：

• 第一行必须是 **PASS** 或 **FAIL**，不得有其他内容
• 问题列表（表格）只包含有问题的行，无问题时整个表格省略（只保留 PASS/FAIL + Patch信息 + 空的"问题清单"）
• # Patch信息 必须包含 URL、Change-Id、Owner、Repo、Branch 五个字段
• # 问题清单 每个问题以 ## {文件}:{行号} 为标题（commit message 使用 ## commit-message:1）
• 每个问题项必须包含 - **原因:** 和 - **建议:** 两行
• 问题列表（表格）每条问题描述不超过 30 字；如有规范编号（CM-1 等），在描述头部标出
• 问题清单每条问题要求简洁，无字数限制

无问题时的输出示例（PASS）：

**PASS**

# Patch信息
URL: https://gerrit.example.com/c/myproject/+/12345
Change-Id: Iabcdef1234567890abcdef1234567890abcdef12
Owner: john.doe@example.com
Repo: myproject
Branch: main

# 问题清单
（无问题）

异常处理

⛔ 约束与禁止事项

不支持的场景

明确禁止的操作

• ⛔ 禁止将 diff 内容（含用户代码）发送到外部服务或第三方 API
• ⛔ 禁止对 Gerrit 做任何写操作（review、comment、Verified 标签等）

幂等性声明

配置参考

Config Reference

Gerrit 连接配置（GERRIT_URL/GERRIT_USERNAME/GERRIT_HTTP_PASSWORD）在 gerrit-api skill 中管理。

与其他 skill 的关系

📚 参考文件

文件清单

code-review/
├── SKILL.md
├── README.md
├── references/
│   ├── review-workflow.md    ← 审查流程 + 报告格式模板
│   └── error-handling-guide.md ← 错误处理指南
└── scripts/
    └── check_env.py          ← 环境检查（验证 gerrit-api、T2MCodingRule 已安装，Gerrit 环境变量已设置）

快速排错

详细错误处理见 references/error-handling-guide.md。

Source: vancebs/skills — distributed by TomeVault.