用途:在代码审查时生成一个本地、自包含的 HTML 页面,帮助审查者理解 PR 的完整故事:改了什么、为什么重要、如何工作、如何融入系统、如何验证。
主要能力:先理解 PR 再写 HTML,收集 PR 标题/编号、分支、链接、基础分支、提交范围、改动文件与已执行的验证。使用 git status --short、git log --oneline -n 10、git diff <base>...HEAD --stat、git diff <base>...HEAD 检查范围;若单个提交承载主要改动,用 git show --stat <commit> 和 git show <commit> 查看。按问题、系统上下文、前后数据或控制流、关键代码改动、测试/构建/人工检查证据、审查者要点的顺序讲解,而非按原始 diff 顺序。将改动文件分类为核心行为、管道/集成、测试、发布元数据或附带噪音,只突出有助于解释的文件。
使用方式:生成文件放在 .pr-review/,用一个包含全部 CSS 和内容的 HTML 文件,默认不提交 .pr-review/,优先用仓库忽略规则或 .git/info/exclude 排除。推荐结构含 Hero、Problem、System Context、Before/After Flow、Code Walkthrough、Tests/Verification、Reviewer Takeaway 及必要图表。验证部分给出确切命令,例如 pnpm --filter @scope/package test path/to/test.ts -- --run、pnpm turbo build --filter ./packages/package。
限制:用通俗语言、短段落、具体前后对比、聚焦代码片段、图表与标注;先说问题再讲实现,先定义缩写或包相关术语,避免倾倒完整 diff 或假设审查者已知内部上下文。若未执行验证需明确说明并列出建议命令。页面不能替代最终完整 diff 审查。其他收费、价格、平台等信息暂未提供。