mcpField
P
prepare-for-review

prepare-for-review

github.com/opengovsg开发136 次安装6 周前更新
代码仓库

关于 prepare-for-review

面向代码作者的技能，将决策记录、ADR 和规格中的理由整理为 PR 正文及行内评论草稿。它会先展示内容和推送计划，获得明确批准后才创建 PR。

主要功能

  1. 01从项目记录收集决策依据
  2. 02按模板整理 PR 正文
  3. 03根据决策记录生成行内评论
  4. 04处理前端截图
  5. 05推送并创建 PR 前征求批准

适用场景

  1. 01为评审者整理变更理由
  2. 02从决策记录准备行内评论
  3. 03发布前检查 PR 材料

安装

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

$npx skills add https://github.com/opengovsg/formsg-ai --skill prepare-for-review

安装后在 Claude Code 中输入/prepare-for-review确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

SCREENSHOTS.md
TEMPLATE.md
agents/
openai.yaml

详细介绍

准备评审

与 review 配套的作者侧流程。将理由从记录它们的位置（决策线索、ADR、规范）移到评审者查看的位置（PR 正文、行内评论）。不会生成理由——来源为空时会省略相应部分。

需要 docs/agents/ticket-tracker.md 和 docs/agents/decisions-breadcrumb.md。如果缺少，请运行 /setup-formsg-ai-skills。

工作流

  1. 确定基准点 — 使用用户提供的 ref，否则使用 main。获取 git diff <fixed-point>...HEAD 和 git log <fixed-point>..HEAD --oneline。

  2. 收集理由来源

    • 决策线索：.scratch/<feature>/decisions.md（可选）
    • ADR：docs/adr/ 中涉及 diff 所含路径的文件
    • 规范/工单：通过 docs/agents/ticket-tracker.md 从提交消息引用中获取，否则使用 .scratch/<feature>/SPEC.md。如果两者都没有，请询问用户。

  3. 整理 PR 正文 — 按照 TEMPLATE.md。省略来源为空的子部分。

  4. 截图（仅限前端） — 如果 diff 涉及前端文件，请按照 SCREENSHOTS.md。

  5. 生成行内评论 — 每条 kind: inline 决策线索对应一条评论：{ file, line, body }。将格式错误的条目（缺少 file/line）告知用户。

  6. 预览 — 展示整理好的正文、行内评论列表和推送计划。等待用户明确批准。

  7. 创建 PR — 获得批准后：

    • 如果没有上游分支，运行 git push -u origin <branch>；否则运行 git push
    • 运行 gh pr create --title "<title>" --body-file <tmp>
    • 通过 gh api repos/{owner}/{repo}/pulls/{n}/comments 发布每条行内评论
    • 输出 PR URL

评论

支持 Markdown