SuperAPI AI 工具集

github-code-review

编程与开发

查看项目

更新于 10-15 15:23

技能介绍

用途

GitHub Code Review Skill 用于对 GitHub Pull Request 进行 AI 驱动的多智能体代码审查。它部署多个专门化的审查智能体,执行超出传统静态分析的、全面的智能代码审查。该技能以 GitHub PR 工作流为核心,通过 gh CLI 获取 PR 上下文与 diff 数据,并借助 npx ruv-swarm 命令驱动审查流程。

主要能力

多智能体审查系统

可部署专门化 AI 智能体进行综合代码审查,初始化示例如下:

PR_DATA=$(gh pr view 123 --json files,additions,deletions,title,body)
PR_DIFF=$(gh pr diff 123)

npx ruv-swarm github review-init \
  --pr 123 \
  --pr-data "$PR_DATA" \
  --diff "$PR_DIFF" \
  --agents "security,performance,style,architecture,accessibility" \
  --depth comprehensive

其宣称的优点包括:多个专用智能体并行审查、覆盖多个领域、加快审查周期、统一质量标准执行。

专用审查智能体

  • 安全审查智能体:识别安全漏洞并建议修复,检查项包括 SQL 注入、XSS、认证绕过、授权缺陷、加密弱点、依赖漏洞、密钥暴露、CORS 错误配置;操作包括在关键问题上阻断 PR、建议安全替代方案、添加安全测试用例、更新安全文档。
  • 性能审查智能体:分析性能影响与优化机会,指标涵盖算法复杂度(Big O)、数据库查询效率、内存分配模式、缓存利用、网络请求优化、打包体积、渲染性能;基准测试包含与基线对比、负载测试模拟、内存泄漏检测、瓶颈识别。
  • 架构审查智能体:评估设计模式与架构决策,检查设计模式遵循、SOLID 原则、DRY 违规、关注点分离、依赖注入、分层违规、循环依赖,并提供耦合、内聚、复杂度、可维护性等指标。
  • 风格与规范智能体:执行编码标准与最佳实践,检查代码格式、命名约定、文档标准、注释质量、测试覆盖、错误处理模式、日志标准,并支持对格式化、导入、空白等自动修复。
  • 可访问性智能体:文档中列为可选智能体之一。

基于 PR 的 Swarm 管理

  • 从 PR 创建 swarm:使用 gh pr view 123 --json body,title,labels,files | npx ruv-swarm swarm create-from-pr,并支持根据 PR 标签自动生成智能体。
  • 标签到智能体的映射:如 bug → debugger、tester;feature → architect、coder、tester;refactor → analyst、coder;docs → researcher、writer;performance → analyst、optimizer;security → security、authentication、audit。
  • 按 PR 规模选择拓扑:小型 PR(小于 100 行)使用 ring 拓扑;中型 PR(100–500 行)使用 mesh 拓扑;大型 PR(大于 500 行)使用 hierarchical 拓扑,命令为 npx ruv-swarm github pr-topology --pr 123。

PR 评论命令与 Webhook

可在 PR 评论中直接执行 swarm 命令,例如 /swarm init mesh 6、/swarm spawn coder "Implement authentication"、/swarm status、/swarm review --agents security,performance。同时文档给出 webhook-handler.js 示例,用于处理 GitHub Webhook 事件,在 PR 打开或评论以 /swarm 开头时触发对应命令。

审查配置与自动化工作流

支持 .github/review-swarm.yml 配置文件,设置自动触发、必需与可选智能体、各智能体的阈值策略(如 security 阻断、performance 警告、style 建议)以及规则。还提供基于路径的自定义审查触发条件,如高风险文件(auth、payment、admin)、性能关键路径(api、database、cache)、UI 变更(components、styles、pages)。文档包含 GitHub Actions 工作流示例,实现 PR 创建时自动审查、更新标签、发布审查结果,以及智能评论生成、批量评论管理。

质量门禁与检查

可定义质量门禁阈值,如 security 无关键问题、performance 回归小于 5%、coverage 最低 80%、architecture 复杂度小于 10、duplication 最大 5%,并跟踪审查指标(发现问题数、误报、修复率、审查耗时)。

高级功能

  • 上下文感知审查:加载相关 PR、分析影响、检查破坏性变更、依赖分析。
  • 从历史学习:分析过往审查、识别模式、改进建议、减少误报,并可针对代码库训练。
  • 跨 PR 分析:对相关 PR 进行批量一致性、集成与综合影响检查,支持多 PR swarm 协调(parallel 策略、共享内存)。
  • 自定义审查智能体:文档给出 custom-review-agent.js 示例,可按自定义规则审查,如检测生产代码中的 TODO 注释、校验 API 版本化,并通过 npx ruv-swarm github register-agent 注册。
  • CI/CD 集成与自动修复:与构建流水线集成(包含构建结果),支持 npx ruv-swarm github pr-fix 123 --issues "lint,test-failures,formatting" --commit-fixes --push-changes 自动修复常见问题,并向 PR 发送进度更新。

使用方式

典型流程为:使用 gh CLI 获取 PR 数据与 diff,通过 npx ruv-swarm github review-init 等命令初始化审查,选择所需智能体与审查深度,再将结果通过 gh pr comment、gh pr review 或 gh api 发布到 PR。也可结合配置文件、GitHub Actions 与 Webhook 实现自动化。

适用场景

适用于需要对 GitHub PR 进行系统化、多维度审查的团队,尤其是安全敏感变更、性能关键路径、UI 变更等场景,以及希望通过 CI/CD 自动执行审查与质量门禁的项目。

限制

该技能依赖 GitHub CLI(gh)与 npx ruv-swarm 工具链。文档中未提供具体收费、价格、平台支持范围及运行环境要求等事实,相关内容暂未提供。所列举的智能体检查项、规则与配置均以文档给出的示例为准,实际效果需以真实使用为准。