SuperAPI AI 工具集

pma-code-review

编程与开发

查看项目

更新于 10-16 11:03

技能介绍

PMA Code Review 是一个用于审查改动代码的技能,采用高信号、低噪声的流程。

用途

该技能适用于以下场景:

  • 提交或合并前的本地差异审查
  • 针对变更行及周边上下文的 Pull Request 审查
  • 对既有代码库进行全仓库审计
  • 希望获得栈感知审查而非通用清单刷屏的 PMA 管理仓库

结构

该技能有一个入口和多个内部审查包:

  • 共享审查策略
  • TypeScript 前端审查
  • TypeScript 后端 / Bun 审查
  • Go 审查
  • Rust 审查
  • Python 审查

入口技能保持精简,仅加载检测到的技术栈所需的参考文件。

快速开始

本地审查:

/pma-code-review

PR 审查:

/pma-code-review <PR-number-or-URL>

仓库审计:

/pma-code-review audit
/pma-code-review repo
/pma-code-review --repo

工作流

  1. 检测审查模式:
    • 无参数:本地差异审查
    • PR 编号或 URL:PR 审查
    • audit、repo 或 --repo:仓库审计
  2. 读取 references/core-review-policy.md。
  3. 若为仓库审计,还需读取 references/repository-audit.md。
  4. 从变更文件与项目清单中检测技术栈。
  5. 仅读取匹配的技术栈包:
    • references/typescript-frontend.md
    • references/typescript-backend.md
    • references/go.md
    • references/rust.md
    • references/python.md
  6. 审查变更代码,以及验证行为所需的最小周边上下文。
  7. 只报告很可能是真实且由本次改动引入的问题;对于仓库审计,仅报告有当前仓库代码证据的问题。

技术栈选择

使用以下启发式规则:

  • TypeScript 前端:tsx、React、Next.js、Vite、路由、UI 组件、浏览器状态、客户端表单
  • TypeScript 后端 / Bun:Hono、Express、Fastify、Nest、Bun 服务端代码、API 路由、数据库访问、worker
  • Go:go.mod、*.go
  • Rust:Cargo.toml、*.rs
  • Python:pyproject.toml、setup.py、requirements.txt、*.py

如果改动跨越多个技术栈,则加载所有相关包,并针对每个变更区域使用正确的包进行审查。

审查优先级

始终按以下顺序审查:

  1. 正确性与回归
  2. 安全与信任边界
  3. 数据完整性与错误处理
  4. 并发、取消与资源生命周期
  5. 性能与可扩展性
  6. 可维护性与测试

除非违反明确的工程规则,否则不要把审查预算花在风格细节上。

本地审查模式

用于未提交或已暂存的改动:

  • 检查已暂存和未暂存的差异
  • 阅读足够的周边代码以验证行为
  • 生成按严重程度排序、以发现项为先的报告
  • 对严重问题阻止批准

PR 审查模式

用于 GitHub Pull Request:

  • 使用 gh 检查 PR 元数据与差异
  • 跳过不合格的 PR,例如已关闭或草稿状态的 PR
  • 收集相关的 CLAUDE.md / AGENTS.md 指引
  • 只审查变更行为及附近上下文,不审查无关的遗留代码
  • 在有用时,按关注点或技术栈拆分审计,然后仅合并高置信度的发现项
  • 通过 gh pr review 将审查发布到 GitHub——发现问题时请求更改,无问题时批准

仓库审计模式

当目标是评估当前仓库而非差异时使用:

  • 盘点项目清单、入口点、CI、测试与技术栈标记
  • 识别高风险区域,例如认证、API 边界、数据库访问、任务、文件系统、外部调用、配置加载与孤立死代码
  • 优先检查风险最高的模块
  • 按根因而非文件数量去重发现项
  • 区分已确认发现项、覆盖缺口与建议的后续行动

输出规则

仅当发现项重要到值得报告时才报告:

  • 优先报告可能破坏行为、安全、正确性或运维的问题
  • 跳过 linter、编译器或类型检查器已保证的问题
  • 跳过未改动的遗留问题,除非改动使其恶化或暴露
  • 当根因相同时,将重复实例合并为一个发现项

本地模式输出:

  • 严重程度
  • 文件与行号
  • 问题
  • 修复方向

PR 模式输出可直接发布的简洁审查评论。

仓库审计模式输出:

  • 按 P0 到 P3 分组的发现项
  • 受影响区域
  • 问题与影响
  • 死代码发现项
  • 死代码移除候选
  • 需要运行时验证
  • 覆盖缺口
  • 建议的后续行动

参考包

  • references/core-review-policy.md:置信度过滤、严重程度策略、共享审查启发式
  • references/repository-audit.md:全仓库审计工作流、热点选择与报告结构
  • references/typescript-frontend.md:React / Next.js / Vite / 浏览器 UI 审查规则
  • references/typescript-backend.md:Node / Bun / API / 验证 / 数据库 / 异步审查规则
  • references/go.md:Go 围绕 context、错误、并发、HTTP 与资源安全的审查规则
  • references/rust.md:Rust 围绕 panic 边界、异步阻塞、unsafe、文档与 API 契约的审查规则
  • references/python.md:Python 围绕验证、反序列化、异步、类型安全与命令注入的审查规则

这些包有意承载详细规则,以使本文件保持精简、加载成本低。