工程开发
pr-review avatar

pr-review

Schmock 项目专用的自动化 PR 审查工具,确保 BDD 测试覆盖率、代码质量、TypeScript 标准及 Commit 规范。

简介

pr-review 技能是 Schmock 生态系统中的专业质量守门员,旨在为每个传入的合并请求 (Pull Request) 强制执行严格的项目标准。它专为需要维护 API Mocking、插件开发和框架适配器高可靠性的维护者和贡献者而设计。通过自动化评估流程,它减少了检查行为文档、类型安全和包完整性所需的认知负担,确保代码库标准在所有存储库中保持一致。

  • 通过确保每个功能或错误修复都有对应的 .feature 场景和匹配的 .steps.ts 定义来验证 BDD 覆盖率。

  • 通过稽核 'any' 类型滥用、泛型错误使用以及自定义插件中的潜在安全性漏洞(如 XSS 或注入攻击)来强制执行 TypeScript 严格模式。

  • 审查架构模式,检查是否过度设计或存在过早抽象化,并验证是否符合 Schmock 项目约定。

  • 检查 Commit 历史记录以确保符合 Conventional Commits 格式(feat, fix, chore),从而保持项目历史整洁且易于维护。

  • 使用如 publint 和 attw 等先进工具检查包完整性,以确保正确的导出、依赖管理和对等依赖范围。

  • 提供结构化且基于严重程度的建议(Blocker, Suggestion, Nit),帮助贡献者快速识别并解决高优先级问题。

  • 此技能需要合并请求编号 (PR number) 作为启动流程的主要参数。

  • 在内部使用 GitHub CLI (gh) 指令来提取差异 (diffs) 和 PR 元数据,因此需要使用 GitHub Token 进行身份验证。

  • 要求项目处于可执行 bun 指令进行测试和验证的状态(例如 bun test:all, bun check:publish)。

  • 输出结构被划分为明确定义的类别,以防止审查人员遗漏关键性的失败点。

  • 用户应确保拥有存储库的必要权限以执行自动化诊断步骤,因为该技能会在与 PR 相关联的分支上执行测试。

仓库统计

Star 数
1
Fork 数
0
Open Issue 数
5
主要语言
TypeScript
默认分支
main
同步状态
空闲
最近同步时间
2026年5月3日 20:37
在 GitHub 查看