mcpField
V
visual-recap

visual-recap

github.com/kentcdodds开发57263 次安装今天更新
代码仓库

关于 visual-recap

visual-recap 是用于在 GitHub 拉取请求中添加标记分隔式摘要的 Agent 技能。它根据差异分类变更，并按风险规定验证步骤及原语映射更新要求。

主要功能

  1. 01根据 Git 差异分类变更
  2. 02添加或替换带标记的 PR 摘要块
  3. 03按变更风险规定验证步骤
  4. 04检查并更新原语映射

适用场景

  1. 01总结非简单的拉取请求
  2. 02在创建 PR 前记录计划
  3. 03验证新增或调整原语的变更

安装

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

$npx skills add https://github.com/kentcdodds/kcd-skills --skill visual-recap

安装后在 Claude Code 中输入/visual-recap确认已加载。

包含的文件

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

references/
block-format.md
scripts/
check-primitives-map.mjs
classify-primitives.mjs
primitives-map.mjs
upsert-recap-block.mjs

详细介绍

系统回顾

当变更并非简单修改（例如制定计划、创建或更新 PR，或请求进行可视化回顾）时，请在 PR 描述中放入一个由标记界定的代码块。GitHub 会渲染该代码块。它不能替代对差异的阅读。

何时使用

回顾模式读取差异，而不是依赖记忆。 关于变更内容的说法必须能通过 git diff <base>...HEAD（以及 --stat）核实。会话上下文只能用于解释意图。

运行分类器。按 adds、extends、composes 的顺序，归并为级别最高的一项。你仍需根据差异选择 composes 还是 extends。adds 表示新增映射条目。

归并结果风险另外
composes低仅涉及接线和调用点。
extends中使用项目的控制 CLI，以预置用户身份在本地验证；只有本地无法验证时才使用 PR 预览
adds高更新 primitives.yaml，运行 check-primitives-map.mjs，并进行同样的本地验证（必要时使用预览）

当此 PR 新增、移除或实质性地重塑某个原语时（新增 id、重命名含义，或必须更改归属根目录），请更新 primitives.yaml。普通功能开发不要编辑 summary。每个风险级别都要指出该映射中受影响的不变量。

在 PR 创建之前，计划模式使用 **Mode:** plan。回顾模式则根据 git diff <base>...HEAD 替换该代码块。在计划模式中，如果计划不需要更改任何原语，请明确说明；这是风险最低的结果。

代码块格式示例： references/block-format.md。

命令

node .agents/skills/visual-recap/scripts/classify-primitives.mjs --base <base> --head HEAD --json
node .agents/skills/visual-recap/scripts/upsert-recap-block.mjs <pr-number> <block-file>
node .agents/skills/visual-recap/scripts/check-primitives-map.mjs

更新脚本会先检查 mermaid，然后替换标记代码块或在末尾追加。它不会编辑标记之外的文本。重大推送后，请重新运行这两个命令。

失败处理

  • mermaid 检查退出时返回非零状态。修复图表。序列注释和消息中不要使用 ;。
  • 代码块文件必须以 开头，并以 结尾。
  • gh pr edit 失败并显示 Resource not accessible by integration (updatePullRequest)。脚本仍会打印合并后的正文。请使用 Cursor ManagePullRequest 应用该正文。不要让 Kody 编辑 PR。
  • 健康检查或登录冒烟测试不属于中风险或高风险验证。优先使用本地控制 CLI 进行验证；只有本地无法验证变更时才使用预览。不要将会话 cookie 输出到 curl 或 Python 命令中。

评论

支持 Markdown