pr-walkthrough

Installation
SKILL.md

pr-walkthrough

为当前分支或 GitHub PR 生成一个本地静态 HTML 讲解页,帮助 reviewer 快速理解 PR 涉及的系统、数据流、代码依赖和用户路径。此技能不是代码评审技能,不生成新的 review finding、approval 或 request-changes 结论。

输出

生成文件到临时目录下的统一 slug 目录。默认本地产物根目录为 ${TMPDIR:-/tmp}/pr-walkthrough(并去掉末尾 /);如果用户明确指定其他目录,可改用指定目录。

优先使用 PR number;无 PR number 时使用当前分支名:

$output_dir/graph.json
$output_dir/index.html

<short-sha> 是生成 walkthrough 时的 head commit 短 SHA。<sanitized-branch> 使用小写字母、数字和 -,把 /、空格和其他分隔符归一为 -。本地目录名和 GitHub Pages 路径必须使用同一个 slug。PR 更新后再次调用会因 short SHA 变化生成新目录;只有用户明确要求更新同一路径时才覆盖旧目录。不要把生成产物写入仓库目录,除非用户明确要求。

站点必须可以直接用 file:// 打开,不要求 dev server、打包器、安装依赖或构建步骤。优先生成单个自包含 HTML 文件,内联 CSS、JavaScript 和图数据;如果必须拆分资源,只使用相对路径,并避免用 fetch() 读取本地数据。

Installs
1
GitHub Stars
170
First Seen
2 days ago