code-review Skill 使用说明

项目简介

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

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

• 用 🔴 / 🟡 / 🟢 三级标注问题严重程度

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

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

• GitHub: zeroanonx/code-review

• skills.sh: zeroanonx/code-review/code-review

如何安装

npx skills add zeroanonx/code-review --skill code-review -g -y

npx skills add zeroanonx/code-review --skill code-review -y

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

npx skills list -g

npx skills add zeroanonx/code-review --list

配套 Skill（建议一并准备）

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

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

~/.agents/skills/
├── code-review/
│   ├── SKILL.md
│   └── rules/best-rules.md
├── vue-best-practices/SKILL.md
├── vercel-react-best-practices/SKILL.md
└── typescript-best-practices/SKILL.md

如何触发 Code Review

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

/code-review

或直接描述：

1. 帮我 CR 一下当前分支的变更
2. 审查这次 PR 的代码
3. 对最近一次任务变更做 code review

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

审查范围怎么选

Skill 会引导你选择本次 diff 范围：

审查流程（10 步）

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

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

• ❌ 禁止跳过读 archive 直接审查
• ❌ 禁止未确认范围就开始审查
• ❌ 禁止只在聊天里给结论、不写 result/backup 文件
• ❌ 禁止把 🟢 可选建议写入 archive

问题怎么分级

审查依据

Agent 会按项目技术栈对照：

1. best-rules — 团队强制项（命名、async/await + try/catch、禁止 any、Vue <script setup> 等）
2. vue-best-practices — Vue 3 项目
3. vercel-react-best-practices — React / Next.js 项目
4. typescript-best-practices — TypeScript 项目

审查产出在哪里

每次 CR 完成后，在被审查项目根目录生成：

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

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

code-review/result/
code-review/backup/

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

HTML 报告包含：审查总结、历史问题回归检查、分级问题清单（含原代码与修复建议）、综合评估与是否建议合入。

典型工作流

常见问题

审查通过时 archive 会更新吗？

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

适合哪些人使用

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

相关链接

• GitHub 仓库
• skills.sh 页面
• Agent Skills 规范
• Skills CLI 文档

联系与反馈

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

• 评论: https://zeroanon.com/others/code-review-help
• 微信: https://zeroanon.com/others/wechat