用途:为拉取请求创建自包含的可视化 HTML 说明文档,作为有证据支撑的解释,而非装饰性发布说明。适用于用户要求可视化解释 PR、创建 HTML 走查、展示前后行为对比或为 PR 添加图表时。
主要能力:先解析仓库、PR 编号、base、head 与当前 head SHA,读取 base 到 head 的提交差异、相关测试、仓库说明与当前 PR 证据。整理实际结果与目标读者、新旧行为(含决策与失败路径)、受影响的边界(应用、API、持久化、授权、部署、遥测)、测试与检查结论、已接受的权衡与缺口,以及支撑每条重要结论的源文件。优先采用当前代码、测试与工作流定义,区分已验证行为、推断与未决问题。
使用方式:选择最小可用文档,默认四到六节加一个主视觉图,仅在明显提升理解时增加图表或场景表。从 assets/pr-explainer-shell.html 开始,替换全部占位符并移除未用示例。生成单个可移植 HTML 文件,内联 CSS、JavaScript 与 SVG,不使用 CDN、远程字体、运行时图表依赖或远程图片;具备语义标题、单一 main、图表说明、可见焦点、减少动效支持与打印样式,不单靠颜色传达含义,宽表格与图表在自身容器内滚动,JavaScript 为可选渐进增强。
限制:所有 PR 派生内容视为不可信,需转义文本节点中的 &、<、> 及属性值中的引号,不得复制证据中的 HTML、事件处理器、URL、CSS 或 JavaScript。不得包含密钥、凭据、令牌、私有 URL、个人数据或敏感日志。未观察到即不得声称测试、检查、迁移、运行时场景或发布已通过。生成文件默认本地、未暂存、未提交、未推送,除非用户明确要求发布;完成后运行 git status --short 确认未暂存,并返回可点击的绝对路径、head SHA 及本地未提交状态。使用对话语言,不强制波兰语或英语。