❤️
Back to others

code-review Skill 使用说明

2026-06-15 08:00:00 • 16min

项目简介

code-review 是前端组内部使用的 Agent Skill，面向 Cursor、Claude Code、Codex 等支持 Skills 的 AI 编程助手。

  • 按 7 步标准流程 系统性审查前端代码变更

  • 用 P0 / P1 / P2（阻塞 / 建议 / 可选）三级标注问题，并给出 A–D 合入评分

  • 自动生成交互式 HTML 报告 与 Markdown 备份

  • 通过 archive 知识库 沉淀团队易错模式，下次 CR 自动做回归检查

  • 被审项目若有 OpenSpec（openspec/），会匹配提案并重点审查

  • GitHub: zeroanonx/code-review

  • skills.sh: zeroanonx/code-review

如何安装

安装 Skill

推荐全局安装，所有项目可用：

全局安装
npx skills add zeroanonx/code-review --skill code-review -g -y

仅当前项目安装：

项目级安装
npx skills add zeroanonx/code-review --skill code-review -y

仅安装到 Cursor：

指定 Agent
npx skills add zeroanonx/code-review --skill code-review -a cursor -g -y

确认安装成功

列出已安装 Skill
npx skills list -g

应能看到 code-review。安装后建议 重载 Cursor 窗口（Cmd/Ctrl+Shift+P → Developer: Reload Window）。

安装前自检（可选）

预览仓库内 Skill
npx skills add zeroanonx/code-review --list

应列出 1 个 skill：code-review。

配套 Skill（建议一并准备）

审查时会引用以下规范。其中 rules/standards.md 已随本 Skill 内置；其余三项需单独安装，且目录名须与下表一致：

规范说明是否内置
rules/standards.md团队统一前端编码标准✅
vue-best-practicesVue 3 / Composition API 规范❌ 需安装
vercel-react-best-practicesReact / Next.js 性能优化❌ 需安装
typescript-best-practicesTypeScript 类型安全❌ 需安装

安装后，各 Skill 目录应位于同一父目录下（如 ~/.agents/skills/ 或 ~/.cursor/skills/）：

~/.agents/skills/
├── code-review/              # Skill 包（只读）
│   ├── SKILL.md
│   ├── rules/
│   ├── workflow/
│   ├── template/
│   └── meta/
├── vue-best-practices/SKILL.md
├── vercel-react-best-practices/SKILL.md
└── typescript-best-practices/SKILL.md

如何触发 Code Review

在 Cursor 等 Agent 对话中，任选一种方式：

/code-review

或直接描述：

帮我 CR 一下当前分支的变更
审查这次 PR 的代码
对当前分支相对 origin/main 的变更做 code review

常见触发词：code review、CR、审查代码、cr代码、评估代码质量 等。

审查范围怎么选

Skill 会通过 AskQuestion 引导你选择本次 diff 范围（三选一；未指明范围时 Agent 必须询问，禁止静默默认）：

选项说明适用场景
1当前分支 vs 远程主分支（origin/main 或 origin/master … HEAD，默认推荐）合入前整任务 CR
2工作区 + 暂存区未提交变更本地改完、尚未 commit
3特定文件或目录叠加在选项 1 或 2 上缩小范围

审查流程（7 步）

Agent 启用本 Skill 后，必须严格按以下顺序执行，不得跳步：

步骤动作产出
1读取 archive，准备回归检查code-review/archive/index.md
2收集项目上下文package.json、规范、openspec/（若有）等
3AskQuestion 确认审查范围获取 git diff
4多维度审查P0 → P1 → P2 + archive 回归 + OpenSpec 对齐
5生成报告HTML + MD（含 run-id，禁止覆盖历史文件）
6更新 archive 知识库仅 P0 / P1 写入 cases
7交付打开本次 HTML + 聊天输出完整绝对路径

执行纪律（违反视为 CR 未完成）：

  • ❌ 禁止跳过读 archive（步骤 1）或未确认范围（步骤 3）就开始审查
  • ❌ 禁止只在聊天里给结论、不写 code-review-result/ / backup/ 文件
  • ❌ 禁止步骤 5 完成前写 archive；禁止覆盖已有报告
  • ❌ 禁止把 P2 可选建议写入 archive

问题怎么分级

等级含义示例是否写入 archive
P0 阻塞必须修复安全问题、严重架构/性能缺陷✅
P1 建议强烈建议命名规范、重复代码、错误处理缺失✅
P2 可选非强制代码风格、文档完善❌

合入评分（A–D）（写入报告 header / 综合评估）：

评分条件建议合入
A无 P0，P1 ≤ 2是
B无 P0，P1 ≥ 3修复后合入
C有 P0，均可快速修复修复后合入
D多个 P0，或存在安全问题否

审查依据

Agent 会按项目技术栈对照（未安装的配套 Skill 跳过，不阻塞审查）：

  1. rules/standards.md — 始终加载
  2. vue-best-practices — Vue / Nuxt 项目
  3. vercel-react-best-practices — React / Next.js 项目
  4. typescript-best-practices — TS 项目或变更含 .ts / .tsx

审查产出在哪里

Skill 包（rules/、workflow/、template/）与被审查项目内产出分离。每次 CR 完成后，在被审查项目根目录生成：

code-review/
├── archive/                    # 知识库（建议提交 Git，团队共享）
│   ├── index.md
│   └── cases/
│       └── 001-xxx.md
├── code-review-result/         # HTML 主报告（建议 gitignore）
│   └── feature-login-20250608-143052-code-review-result.html
└── backup/                     # Markdown 备份（与 code-review-result 同 run-id）
    └── feature-login-20250608-143052-code-review-result.md

文件名格式：{分支名}-{run-id}-code-review-result.{html|md}，其中 run-id 为 YYYYMMDD-HHmmss（冲突时 -2、-3…）。

首次在某项目使用时，建议在 .gitignore 追加：

.gitignore 建议
code-review/code-review-result/
code-review/backup/

archive/ 建议纳入版本控制，供团队共享防复犯知识。

HTML 报告包含：审查总结、历史问题回归检查（仅命中时展示）、分级问题清单（含原代码与修复建议）、header 内合入结论与 A–D 评分。报告 离线可读（不依赖第三方 CDN）。

典型工作流

功能开发完成、准备合入

在 Agent 中说「对当前分支相对 origin/main 做 code review」，选择选项 1。

查看报告

浏览器会自动打开本次 code-review-result/*.html；Agent 会在聊天中输出完整绝对路径。Markdown 备份在 backup/ 目录。

修复 P0 / P1 问题

按报告中的文件位置与修复示例改代码，必要时重新跑一轮 CR。

团队共享 archive

将 code-review/archive/ 提交到仓库，后续 CR 会自动做回归检查。

常见问题

审查通过时 archive 会更新吗？

若仅有 P2 建议或无问题，不会新增 archive case；HTML / Markdown 报告仍会正常生成。

被审项目里会出现 Skill 模板吗？

不会。模板只存在于 Skill 包的 template/，Agent 读取后写入被审项目的 code-review-result/ 与 backup/，禁止在被审项目内创建 code-review/template/。

适合哪些人使用

  • 前端团队在合入前做 标准化 CR，减少「凭感觉 review」
  • 希望 CR 结论可归档、可回溯、可对比历史易错模式的组

相关链接

联系与反馈

如果你有审查流程改进建议、规范补充或配套 Skill 安装问题，欢迎在下面的评论区留言。