Open Code Review Delegate

alibaba/open-code-review/skills/open-code-review-delegate

作者 alibabafabbdb296b0d97e2140ada8d54ca7d6d6d1d7ad4Apache-2.044K 个星标收录于 2026年10月9日更新于 2026年10月9日仓库今天更新

Delegation mode for open-code-review (OCR). Instead of OCR calling an LLM endpoint, this skill instructs the host agent to perform the code review itself, using OCR only for deterministic engineering: file selection and rule resolution. Use when the host agent should drive the review with its own LLM capabilities.

AI 生成的概览

open-code-review 的委派模式:由宿主智能体执行代码审查,ocr CLI 仅负责文件筛选与规则解析。

功能
该技能引导宿主智能体完成 AI 代码审查流程,其中 ocr CLI 只承担确定性的工程工作:预览哪些文件可审查、按文件解析审查规则,并输出模式与 ref 元数据。随后智能体用 git 获取差异,依据规则组逐个审查文件,并按路径、内容、行号范围、类别和严重程度格式化评论。最后按严重程度归类发现,并报告总文件数、已审查与已跳过文件等覆盖率信息,还可选地对高危及严重问题执行修复。
适用场景
适用于希望由宿主智能体使用自身模型和工具主导代码审查,而不是通过 OCR 调用已配置 LLM 端点的场景。适合审查 Git 仓库中的工作区改动、分支区间或单个提交。
运行要求
需要安装 ocr CLI,例如通过 npm install -g @alibaba-group/open-code-review 或 GitHub 发布版二进制文件;OCR 侧不需要配置 LLM 端点。需要 Git 仓库和 git 命令,且 --format json 需要 ocr v1.9.0 或更高版本。该技能不附带脚本,仅包含说明。

Open Code Review — Delegation Mode

A skill for performing AI code review where OCR provides deterministic engineering (file filtering, rule resolution) and the host agent performs the actual review using its own intelligence and tools.

Workflow

Step 1: Preview — Determine What to Review

bash
ocr delegate preview --format json [--from <ref> --to <ref>] [--commit <hash>] [--exclude <patterns>]

This outputs:

  • mode (workspace / range / commit)
  • from / to / commit / merge_base — ref metadata for constructing git commands
  • Reviewable file list — paths, status, insertions/deletions
  • Excluded files — with exclusion reason

Common invocations:

ScenarioCommand
Workspace changesocr delegate preview
Branch comparisonocr delegate preview --from main --to feature
Single commitocr delegate preview -c abc123

Step 2: Get Rules for Files

bash
ocr delegate rule --format json <path1> <path2> ...

Pass the reviewable file paths from Step 1. Output is grouped by rule content — files sharing the same rule appear under one group, avoiding repetition.

Step 3: Get Diffs

Use git directly based on the mode/ref info from Step 1:

Range mode (merge_base provided in preview output):

bash
git diff <merge_base>..<to> -- <path>

Commit mode:

bash
git show <commit> -- <path>

Workspace mode:

bash
# Tracked filesgit diff HEAD -- <path># New untracked files — read directly (entire file is new code)cat <path>

Step 4: Review Each File

Create a checklist containing every reviewable_files entry. For each reviewable file:

Use (path, status) as the checklist identity. Workspace mode can report the same path twice when a staged deletion is followed by an untracked recreation.

  1. Get its diff (Step 3)
  2. Consult its Rule Group (from Step 2) for the review checklist
  3. Conduct a thorough review, using appropriate context tools as needed
  4. Mark the file reviewed, or skipped with a concrete reason

For large changes, review in bounded batches grouped by shared rules and diff size. Do not stop after finding the first high-severity issue.

Step 5: Format Output

Each comment must follow this structure:

FieldTypeRequiredDescription
pathstringyesRelative file path
contentstringyesReview comment describing the issue
start_lineintegernoStart line in the new file
end_lineintegernoEnd line in the new file
categoryenumnobug, security, performance, maintainability, test, style, documentation, other
severityenumnocritical, high, medium, low

Step 6: Classify and Report

Before reporting, verify that every previewed file is accounted for. Include total_files, reviewed_files, skipped_files, and coverage_rate in the summary. A skipped file must include its reason.

Group findings by severity:

  • Critical/High: Bugs, security issues, data loss risks — always report
  • Medium: Performance concerns, error handling gaps, maintainability issues — report with context
  • Low: Style nits, minor suggestions — report only if clearly valuable

Discard likely false positives silently.

Step 7: Fix (Optional)

If the user requested "review and fix":

  • Apply High/Critical fixes directly
  • Describe Medium fixes that require manual intervention
  • Skip Low-priority items unless trivial

Sub-commands Reference

CommandPurpose
ocr delegate previewWhich files to review + mode/ref metadata
ocr delegate rule <path...>Review rules grouped by content

Shared Flags

FlagDescription
--from <ref>Source ref for range mode
--to <ref>Target ref for range mode
-c, --commit <hash>Single commit mode
--repo <path>Repository root (default: cwd)
--rule <path>Custom rule.json path
--exclude <patterns>Comma-separated exclude patterns
-b, --background <text>Business context
-B, --background-file <path>Business context from Markdown file (takes precedence over -b)
-f, --format <text|json>Output format; use json for agent integrations

Gotchas

  • No LLM needed on OCR side — delegation mode never calls an LLM. All intelligence comes from the host agent.
  • Rules are grouped — Files sharing the same rule are grouped together in the output. You can pass any number of paths per call; for large changes, fetch rules per-batch as you review.
  • Working directory matters — ocr delegate operates on the Git repo at the current directory. Use --repo /path to override.
  • Untracked files in workspace mode — preview includes untracked files. For these, read the file directly instead of using git diff.
  • Background context — pass --background to preview when you have requirement context; it appears in the output for your reference during review.
  • Coverage is mandatory — every reviewable_files entry must end as reviewed or explicitly skipped; do not silently omit files.

Recovering Oversized Background Context

--background-file has two independent limits. The raw file must not exceed 1 MiB, and the sanitized content must not exceed 8000 characters. Either condition aborts the command. When the command reports either limit:

  1. Do not silently truncate the source file.
  2. Summarize the original material while preserving its requirements, constraints, acceptance criteria, and other review-critical details.
  3. Retry the affected command by passing the summary as one shell-safe argument (for example, use a quoted/escaped argument produced by the host shell, or write it to a new size-bounded file and pass that file). Do not place untrusted summary text directly in a double-quoted shell template; $(), backticks, quotes, and variable references can still be evaluated. Omit the original --background-file so the CLI does not reload the same oversized file and fail again.
  4. If a faithful summary is not possible, omit the OCR background entirely and read the original material directly during the review.

Troubleshooting CLI Version Compatibility

The --format flag is available in ocr v1.9.0 and later. The Skill and the installed CLI can be updated independently. If a requested preview or rule command with --format json fails specifically with unknown flag: --format, rerun it without the flag and use text output for the rest of the delegation run. Preserve the explicit mode, ref, file, and rule information from that output; do not parse text output as JSON or invent missing schema fields. Do not retry without the flag for any other error; report it and stop the affected workflow.

The host-agent Skill may consume the equivalent text output to complete its review checklist. Programmatic integrations that require schema_version or other JSON fields must require a JSON-capable CLI instead: verify with ocr --version and upgrade when necessary:

bash
npm install -g @alibaba-group/open-code-review

来源与署名

来源:alibaba/open-code-review位于skills/open-code-review-delegate提交fabbdb2

许可证: Apache-2.0

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架