SuperAPI AI 工具集

code-quality-review

编程与开发

查看项目

更新于 11-04 20:00

技能介绍

用途

code-quality-review 是一个代码质量审查技能,主要用于三类工作:评估收到的评审反馈、按请求审查指定代码,以及验证完成声明。其目标是确保被接受的代码正确、易于修改且符合项目约定。

主要能力

  • 审查模式:独立使用时默认 --review-only(别名 --report-only);--fix-loop 启用“审查 → 验证 → 授权修复 → 重新审查”循环,默认上限 3 轮;--fix-loop --loop-owner=caller 返回只读结果给负责修复和重新审查的调用方。
  • 报告驱动两阶段审查:先创建报告文件,再逐文件审查并更新报告,最后进行整体评估和最终结果汇总。
  • 影响范围评估:通过 grep/read 评估调用方和依赖方,可选使用代码图提示高风险变更。
  • 全链路影响追踪:追踪主要受影响区域在客户端↔服务端以及服务/事件/外部边界的完整管道,将每个接缝分类为 NONE/ADDITIVE/BREAKING。
  • 高风险变更类型检测:检测依赖升级、迁移/模式变更、总线事件/消息、API 契约变更、安全变更、配置/环境变更、基础设施变更等。
  • 计划合规检查:当存在活动计划时,验证变更文件和测试是否符合计划。
  • 表面检测与子代理路由:按语言、目录语义和变更性质分类文件,路由到相应子代理;前端/UI 文件存在时调用 $ui-design --mode=review。
  • 修复循环:验证发现的问题,仅修复当前轮次阻塞的有效问题,修复后重新完整审查。
  • 验证门禁:完成声明前需要证据。

使用方式

该技能通过 $skill-name 调用,加载注册的 .agents/skills/<name>/SKILL.md 并使用 Codex 工具执行。执行时需按声明顺序执行步骤,不得跳过、重排或合并步骤,除非用户明确批准。每个步骤开始前更新待办跟踪状态,完成或跳过时需附简要证据或明确跳过原因。

审查前必须搜索项目特定参考文档,包括编码标准(code-review-rules、coding-standards、style-guide、contributing)、架构(patterns-reference、architecture、adr)、测试约定(integration-test-reference、test-guide、test-conventions)和设计系统(design-system、design-tokens、component-library)。

工作流程包括:创建审查报告 → 评估影响范围 → 变更上下文与全链路影响追踪 → 风险检测 → 计划合规 → 表面检测 → 逐文件审查 → 整体评估 → 最终结果 → 验证发现 → 修复有效阻塞问题 → 修复后完整重新审查。

适用场景

  • 评估收到的代码评审反馈
  • 按请求审查指定代码
  • 验证完成声明
  • 审查当前变更、未提交工作、暂存/未暂存差异或分支间差异时,应改用 changes-review 技能

限制

  • 当前变更、暂存/未暂存差异和分支差异属于 changes-review 的职责范围,不在本技能处理。
  • 审查需要 file:line 证据,置信度需超过 80% 才可行动。
  • 代码图提示可能滞后于未提交或未索引的文件,需通过阅读验证。
  • 当范围过大无法良好审查时,应在返回中说明,而不是抽样或生成审查者。
  • 无效或未解决的声明保持 BLOCKED 状态,不得创建影子注册表。
  • 未找到参考文档时,检查本地代码/配置并说明重要假设。
  • 关于收费、价格、平台支持等具体信息暂未提供。