Structured PR Review

基于gh CLI的结构化PR审查与反馈回应,支持多层分析与严重性分级。

已扫描
适合谁
开发工程师、技术负责人
不适合谁
非开发者、无GitHub权限用户
国内可用性
需网络配置。可能需要网络配置或第三方服务可访问。
安装难度
新手友好(★☆☆)。基于终端操作、依赖、API Key 和本地环境要求的初步判断。

安装与下载

openclaw skills install @ggettert/structured-pr-review

Skill 说明

命令、参数、文件名以原文为准

结构化 PR 审查

两种模式:给出审查意见和回应审查评论。无外部依赖,仅使用 gh CLI。

给出审查意见

当被要求审查或检查一个 PR 时:

  1. 获取 PR 的详细信息和完整差异(diff)
  2. 按顺序遍历每一层审查内容(参见 [references/review-layers.md](references/review-layers.md)):

- 安全 — 密钥、注入攻击、认证机制、信息暴露

- 正确性 — 逻辑错误、边界情况、错误处理

- 规范 — 团队标准(可通过 [references/conventions.md](references/conventions.md) 自定义)

- 基础设施即代码(IaC) — Terraform/CloudFormation 检查(可通过 [references/iac-checklist.md](references/iac-checklist.md) 自定义)

- 测试 — 测试覆盖率,新增代码需有测试

  1. 生成结构化的审查结论,包含严重性等级

核心原则:

  • 表达直接 — “这个方案存在问题” 比 “有趣的尝试” 更有效
  • 每个问题都应说明如何修复,而不仅仅是指出问题所在
  • 肯定 PR 中做得好的部分
  • 若对严重性不确定,选择更低一级的判断

参见 [references/review-layers.md](references/review-layers.md) 了解完整框架和结论格式。

回应审查评论

当被要求回应、修复或处理 PR 反馈时:

  1. 获取所有审查评论(行内 + 整体评论)
  2. 修复每个问题,或说明不修复的原因
  3. 对每条评论作出回复 — 不留任何未回应的评论
  4. 解决评论线程,更新 PR 描述,推送更改

参见 [references/addressing-workflow.md](references/addressing-workflow.md) 获取分步操作流程。

关键规则:

  • 永远不要留下未回应的评论 — 必须回复每一条
  • 修改后务必更新 PR 描述
  • 在关闭关联问题前,确认 PR 已实际合并

自定义配置

此技能自带通用审查层级。可根据团队需求进行自定义:

  • [references/conventions.md](references/conventions.md) — 编码规范、提交格式、命名规则。默认包含常见规范 — 可根据团队实际情况调整
  • [references/iac-checklist.md](references/iac-checklist.md) — 添加适用于你团队的 IaC 检查项(如必需标签、允许区域、提供者版本锁定)。默认包含常见 Terraform 模式 — 可按组织需求扩展

参考资料

  • [references/review-layers.md](references/review-layers.md) — 审查框架、严重性等级、结论格式
  • [references/addressing-workflow.md](references/addressing-workflow.md) — 评论处理、线程解决流程
  • [references/conventions.md](references/conventions.md) — 团队规范(可自定义)
  • [references/iac-checklist.md](references/iac-checklist.md) — IaC 审查清单(可自定义)

与其他技能配合良好

  • terraform-skill (antonbabenko) — Terraform 编写最佳实践、模块模式、测试策略
  • conventional-commits — 提交消息格式规范(在回应审查时非常有用)
  • github (内置) — 用于 PR、问题和 CI 运行的通用 gh CLI 操作
  • gh-issues (内置) — 自动化 PR 监控与审查触发
G
@ggettert

已收录 1 个 Skill

相关推荐