mcpField
C
check-impl-against-spec

check-impl-against-spec

github.com/warpdotdev测试与质量63627.0k 次安装1 周前更新
代码仓库

关于 check-impl-against-spec

check-impl-against-spec 用于在 PR 评审中,将检出分支的实现与 spec_context.md 中的承诺进行比较。它识别实质性偏差,并将相关发现纳入现有评审结果,而非另建报告。

主要功能

  1. 01提取明确的规格承诺
  2. 02对照规格、差异和代码
  3. 03标记实质性不匹配
  4. 04将发现纳入评审结果
  5. 05不要求实现细节完全一致

适用场景

  1. 01检查 PR 是否实现所需行为
  2. 02核实规格要求的子系统变更
  3. 03检查是否遗漏验证或迁移步骤

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/warpdotdev/common-skills --skill check-impl-against-spec

安装后在 Claude Code 中输入/check-impl-against-spec确认已加载。

详细介绍

根据规范检查实现

仅在 PR 审查期间存在 spec_context.md 时使用此技能。

目标

判断已检出的 PR 中的实现是否实质上符合已批准的规范上下文。这是对常规代码审查的补充,而非单独的输出。

输入

  • spec_context.md 包含要进行对照的规范上下文。其中可能同时包含产品规范内容(预期行为、验收标准)和技术规范内容(实现细节、文件变更)。
  • pr_diff.txt 包含 PR 的带注释差异。
  • pr_description.md 可能包含其他范围说明或理由。
  • 工作树包含 PR 分支的内容。

流程

  1. 阅读 spec_context.md,并提取其中的具体承诺:
    • 必需行为(来自产品规范)
    • 必须更改的文件或子系统(来自技术规范)
    • 声明的约束
    • 必需的后续步骤、验证或迁移
  2. 将这些承诺与 pr_diff.txt 和已检出的文件中的实际实现进行对照。
  3. 如果细微的实现层面调整仍能保留规范意图,则视为可接受。不要指出无害的命名、结构或底层技术差异。
  4. 仅当存在实质性不符时才标记,例如:
    • 产品规范要求的行为缺失
    • 实现与规范中的决定相矛盾
    • 变更引入了大量计划外范围
    • 缺少技术规范要求的验证、迁移或兼容性步骤

输出

  • 不要创建单独的报告文件。
  • 将规范对齐方面的发现纳入 review.json。
  • 在审查摘要中说明广泛的规范偏离问题。
  • 仅当不符之处可关联到差异中的变更行时,才添加行内评论。
  • 将实质性的规范偏离至少视为重要问题。
  • 如果实现与规范足够一致,不要仅为说明对齐情况而添加评论。

边界

  • 如果 PR 安全地实现了相同结果,不要要求逐字逐项照搬规范。
  • 不要推测 spec_context.md 中实际未包含的规范细节。
  • 不要直接向 GitHub 发布内容。

评论

支持 Markdown