关于 code-review
Code Review 是用于依据测试、项目术语和相关设计文档评估代码变更的仓库技能。它重视回归问题的证据,并区分有依据的设计变更与未说明的偏离。
主要功能
- 01检查变更测试与回归测试
- 02核对项目术语一致性
- 03查阅相关设计文档
- 04对照设计要求审查变更
- 05评估设计变更的理由
适用场景
- 01审查缺陷修复拉取请求
- 02检查 CLI 或集成变更
- 03评估架构一致性
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ github/ spec-kit --skill code-review安装后在 Claude Code 中输入/code-review确认已加载。
详细介绍
代码审查
- 确保每项代码变更都有测试用例,验证代码应执行的操作以及应阻止的情况。
- 确保修复 Bug 的拉取请求包含回归测试,证明变更前可以复现 Bug,变更后已修复;如果审查者无法运行对比测试,则使用现有证据并说明这一限制。
- 确保措辞变更使用与仓库一致的术语;此项检查不包括社区编写的目录内容及其生成的文档。
- 确定受影响的领域,并在评估架构一致性之前阅读
design/中适用的文档。对于 CLI 命令变更,请参考design/cli.md;对于 Agent 集成,请参考design/integration.md;对于工作流步骤类型,请参考design/workflow-step.md。其他设计文档仅在相关时阅读,无需针对每个 PR 阅读所有文档。 - 根据适用的设计要求检查变更,包括实现边界、所有权、生命周期和交付要求。请引用相关文档,而不要在此技能中重复其规则。对于每项报告的不一致,都要注明文档及章节。
- 区分无法解释的设计违规与有意的设计变更。评估有意变更的理由和证据;仅更新设计文档并不能证明实现合理。
评论
支持 Markdown