用途:为非平凡 PR(新增或变更公共 API、新模块/子系统、核心逻辑行为变更、迁移等)编写一份可评审的设计文档,弥补 diff 只显示逐行改动、无法呈现设计意图的不足。目标是节省维护者注意力,让评审者约 15 秒内看懂改了什么、是否有风险、先看哪里。
主要能力:生成单个自包含、可离线打开的 HTML 页面,内联 CSS/SVG,无外部脚本或资源;包含改动摘要(结论优先)、API 前后对比、按区域分组的文件索引、逐文件卡片(含前后示意图与折叠 diff)、可选风险与后续事项。所有节点和结论都标注真实符号与 file:line,并尽量链接到正确版本(before 用 merge-base SHA,after 用已验证的 head SHA)。
使用方式:先检出并验证 PR head,确认 git rev-parse HEAD 与 gh pr view <n> --json headRefOid 一致;用 git merge-base 计算合并基点;对比 git show <merge-base-sha>:<path> 与 head 读取前后行为;将 HTML 保存到 .pr/design.html 或 .pr/<topic>.html,提交并推送到已验证的 PR head,再从 PR 描述链接。公开仓库可用 htmlpreview 链接;私有或内部仓库必须使用受访问控制的 GitHub blob 或本地下载方式,禁止通过公开托管发布。
限制:仅适用于非平凡 PR,琐碎改动(拼写、单行守卫、依赖升级、文档微调、简单修复)应跳过。文档是临时评审辅助,不得合入主干;依赖自动清理前须确认仓库启用了 .github/workflows/pr-artifacts.yml,否则合并前手动删除 .pr/。写入前需拒绝 .pr 或输出路径上的符号链接。自动批准可能在人工评审前触发清理,因此关键设计摘要应保留在 PR 描述中,并使用固定 commit 的文档链接。资料未提供具体安装命令、收费或平台信息。