用途
Code Review 用于执行结构化的代码审查,支持两种对象:本地改动和 GitHub PR。当被要求 review 代码、检查改动、审计 diff 或分析代码时使用。
主要能力
该技能针对不同输入采取不同取数方式:
- 若参数是 PR 编号或 URL:运行
gh pr diff $ARGUMENTS获取 diff,运行gh pr view $ARGUMENTS获取 PR 描述和元数据,运行gh pr checks $ARGUMENTS查看 CI 状态。 - 若无参数(本地改动):先运行
git diff --staged;若为空,运行git diff;若仍为空,运行git diff HEAD~1。
随后在所有情况下均执行并行代理以提高效率:
- Agent 1:读取所有改动文件的完整内容以获取上下文。
- Agent 2:在适用时运行
npm run lint/npm run test/npx tsc --noEmit。
并依据下方检查清单进行审查。对于 PR,如被要求,可使用 gh api 起草 GitHub review 评论。
输出格式
## Code Review: [PR title or branch name]
### CI Status
- Lint: PASS/FAIL | Tests: PASS/FAIL | Types: PASS/FAIL
### Critical (must fix before merge)
- **[file:line]** Description
**Fix**: Suggested fix or approach
### Important (should fix)
- **[file:line]** Description
**Fix**: Suggested fix or approach
### Suggestions (nice to have)
- **[file:line]** Description
### Summary
- **Files reviewed**: N
- **Issues found**: N critical, N important, N suggestions
- **Overall**: APPROVE / REQUEST CHANGES / NEEDS DISCUSSION
/code-review 与 /pr-review 的对比
| Aspect | /code-review | /pr-review |
|---|---|---|
| Scope | 本地改动(staged/unstaged/最后一次提交) | GitHub PR(远程) |
| CI Status | 本地运行检查 | 读取 GitHub CI 状态 |
| Output | 内联发现项 | 内联发现项 + 可选 GH review 评论 |
| Best For | 提交前质量检查 | 审查他人的 PR |
| Trigger | "review my code"、"check my changes" | "review PR #123"、"review this PR" |
时间限制
- 小型 diff(<200 行):2 分钟内完成。
- 中型 diff(200-1000 行):5 分钟内完成。
- 大型 diff(>1000 行):提醒用户范围,仅聚焦 Critical/Important,跳过 Suggestions。
检查清单
Critical(合并前必须修复):
- 安全:SQL 注入、XSS、命令注入、路径穿越
- 安全:硬编码密钥、API key、密码
- 安全:缺少认证/授权检查
- 数据丢失:破坏性操作无确认
- 数据丢失:缺少数据库迁移或向后兼容
- 运行时错误:null/undefined 访问、未处理异常
- 破坏性变更:公共 API 或契约变更但无版本管理
Important(应当修复):
- 类型安全:正确的 TypeScript 类型,避免 any
- 错误处理:有意义的错误信息,正确的错误边界
- 测试:新功能有测试,覆盖边界情况
- 性能:N+1 查询、不必要的重渲染、大体积导入
- API 契约:破坏性变更已文档化、向后兼容
- 无障碍:语义化 HTML、ARIA 标签、键盘导航
- UX:加载状态、错误状态、空状态均有处理
Suggestions(可选):
- 代码清晰度:命名、注释、降低复杂度
- DRY:可提取的重复逻辑
- 模式:与现有代码库模式一致
- 文档:更新 README、为公共 API 添加 JSDoc
限制与约束
- 在审查过程中不得修改、修复或编辑任何代码。
- 不得提交任何改动。
- 只报告发现项并建议修复方案——绝不应用它们。
其他信息
暂未提供关于计费、价格、平台支持范围、实际性能效果等方面的信息。