SuperAPI AI 工具集
合作ENAI 行业资讯收藏
Skill 广场code-review-playbook

code-review-playbook

编程与开发

查看项目

更新于 10-15 15:08

技能介绍

用途

Code Review Playbook 用于让代码审查更彻底、一致且有建设性，目标是提升代码质量、共享知识并促进协作。它适用于以下场景：审查 pull request 或 merge request；为代码送审做准备（自查）；为团队建立代码审查标准；培训新开发者掌握审查最佳实践；解决关于代码质量的分歧；改进审查流程与效率。

主要能力

审查流程框架

  • 审查前：阅读 PR/MR 描述，理解目的与范围，查看关联工单或 issue，检查 CI/CD 流水线状态；确认自动化检查（测试通过、Lint 无错误、类型检查通过、覆盖率达标、无合并冲突）；并预留时间：小型 PR（< 200 行）15-30 分钟，中型 PR（200-500 行）30-60 分钟，大型 PR（> 500 行）1-2 小时或要求拆分。
  • 审查中：按模式推进——高层审查（5-10 分钟，读描述、略读改动、核对架构与目的）、细节审查（20-45 分钟，逐行检查逻辑、边界情况、错误处理、测试覆盖、安全漏洞、团队约定）、测试考量（5-10 分钟）、文档检查（5 分钟）。
  • 审查后：给出明确结论（批准 / 评论 / 请求修改），及时回答作者问题、在问题解决后重新审查并批准、感谢作者处理反馈。

Conventional Comments 注释

提供如 issue [blocking]: Missing error handling for API call、security [blocking]: API endpoint is not authenticated 等格式。完整格式、标签（praise、nitpick、suggestion、issue、question、security、bug、breaking）、装饰（[blocking]、[non-blocking]、[if-minor]）与示例见 references/conventional-comments.md。

审查清单

  • 通用代码质量：可读性、命名、注释、格式、DRY、SOLID 原则、函数规模（< 50 行）、圈复杂度（< 10）。
  • 安全：认证、授权（用户只能访问自己的数据）、输入净化（防 SQL 注入、XSS）、密钥管理（无硬编码凭据或 API 密钥）、加密、限流。

上游覆盖分工（本技能不重复）

  • 审查哲学、速度、语气、PR 规模：https://google.github.io/eng-practices/review/
  • Conventional Comments 标签与装饰：references/conventional-comments.md、https://conventionalcomments.org/
  • OWASP Top 10 审查检查：rules/security-baseline.md、https://owasp.org/Top10/
  • 通用语言与框架审查清单：rules/typescript-quality.md、rules/python-quality.md、rules/linting-biome-rules.md
  • 审查报告形态与多智能体全 PR 审查：ork:review-pr
  • 将发现应用到工作区：/code-review --fix、/simplify
  • 仅针对当前分支的安全检查：/security-review
  • GitHub 审查机制（approve、request changes、行内评论）：https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests

本技能为轻量封装，通用审查方法在别处已有第一方文档，此处只保留 OrchestKit 自身的决策；房屋规则见 Read("references/ork-delta.md")。

内置审查命令（CC 2.1.152+）

  • /code-review：审查当前 diff 的正确性缺陷以及复用/简化/效率方面的清理项。
  • /code-review --fix（CC 2.1.152+）：先运行审查，再把发现应用到工作区（覆盖正确性及复用/简化/效率的缺陷排查）。
  • /code-review --comment：将发现作为行内 PR 评论发布。
  • /simplify：CC 2.1.154 起改为仅清理型审查（复用、简化、效率、altitude）并应用修复，不再触发完整的 /code-review --fix 缺陷排查。整理用 /simplify，找 bug 加修复用 /code-review --fix。
  • 快速、diff 范围的检查使用内置命令；多智能体、全 PR 审查（安全 + 测试 + 架构）使用 ork:review-pr。

规则文件（按需加载，共 5 条规则，4 个类别）

  • TypeScript Quality：rules/typescript-quality.md，HIGH，关键模式：No any、Zod 校验、穷尽 switch、React 19。
  • Python Quality：rules/python-quality.md，HIGH，关键模式：Pydantic v2、ruff、mypy strict、异步超时。
  • Security Baseline：rules/security-baseline.md，CRITICAL，关键模式：无密钥、端点鉴权、输入验证。
  • Linting：rules/linting-biome-setup.md，HIGH，Biome 安装、ESLint 迁移、渐进采用。
  • Linting：rules/linting-biome-rules.md，HIGH，Biome 配置、类型感知规则、CI 集成。

脚本与资产

  • scripts/review-pr.md：动态 PR 审查，自动抓取 GitHub 数据（PR 标题、作者、状态、变更文件、diff 统计、评论数）。用法：review-pr [PR-number]。需要 GitHub CLI（gh），使用 $ARGUMENTS 与 !command 获取实时 PR 数据。
  • assets/pr-template.md：PR 描述模板。
  • 此处刻意不提供审查报告模板，该输出形态由 ork:review-pr 负责，详见 references/ork-delta.md。

使用方式

审查者：阅读 PR 描述并理解意图；确认自动化检查通过；做高层审查（架构、方法）；做细节审查（逻辑、边界、测试）；用 Conventional Comments 清晰沟通；给出结论：批准、评论或请求修改。

作者：撰写清晰的 PR 描述；请求审查前先自查；确保所有自动化检查通过；保持 PR 聚焦且规模合理（< 400 行）；及时且尊重地回应反馈；按要求修改或解释理由。

适用场景与限制

适用于 PR/MR 审查、送审前自查、团队审查标准建设、新人培训、质量分歧解决与流程优化。限制：本技能为轻量封装，审查哲学、速度、语气、PR 规模等通用内容需参考 Google 工程实践；Conventional Comments 完整格式见其参考文件与官网；OWASP 检查见安全基线规则与 OWASP Top 10；报告形态由 ork:review-pr 决定；内置命令依赖 Claude Code 版本（2.1.152+、2.1.154+ 等）。技能版本 2.0.0，最后更新 2026-01-08，由 OrchestKit 维护。

相关技能

  • ork:architecture-patterns：在代码审查中执行测试与架构最佳实践。
  • ork:security-patterns：鉴权、输入验证与 OWASP 模式，补充人工审查。
  • ork:testing-unit：单元测试模式，供审查时验证。