visual-pr 的用途是把一个拉取请求的改动,以紧凑的可视化说明形式发布成 GitHub PR 评论,帮助评审者快速理解。它不会替换或追加 PR 描述。
主要能力与流程:先查找或创建 PR,使用 gh pr view --json url,number,title,state,baseRefName,headRefName 获取信息;当前分支已有打开的 PR 时直接使用。若没有 PR,则检查分支、必要时提交任务改动、推送,并按仓库惯例创建草稿 PR,不把可视化说明当作 PR 正文。只有在当前分支没有相关工作且无法安全创建 PR 时,才让用户选择 PR。随后阅读工单和相关产物,阅读完整 PR diff 及足够上下文,只保留评审者需要理解的契约、职责和运行时路径。
撰写说明时,先读取 $SKILL_PATH/references/comment-template.md,再写入临时文件:COMMENT_FILE=$(mktemp "${TMPDIR:-/tmp}/visual-pr-comment.XXXXXX")。要求简洁:Why 用一句话说明;Special things to note 只放评审警告、迁移、兼容限制、有意省略或意外决策,没有时写 - None.;Change outline 用结构视图,而非散文或逐文件变更日志,可用一到三个视图,如数据或 API 形态、伪代码、浅层文件树、组件树或调用/控制/数据流;对已有形态的改动优先用 diff 块展示,大部分为新增时展示完整目标形态;使用 diff 中的真实名称,并省略未变化的类别。
发布与校验:COMMENT_URL=$("$SKILL_PATH/scripts/publish-comment.sh" <number> "$COMMENT_FILE"),随后校验并清理临时文件。脚本会添加隐藏的 visual-pr 标记,更新当前 GitHub 用户已有的标记评论,或在其不存在时运行 gh pr comment,因此同一 PR 每个用户最多有一条 visual-pr 评论。切勿用 gh pr edit 发布该说明,因为那会替换 PR 描述。完成后回复 PR URL、评论 URL、两句话摘要以及命令成功的校验结果,语言简洁、避免术语。
限制:仅应在用户明确要求 visual-pr 时使用;资料未提供具体安装方式、价格与适用平台等信息。