关于 pr-self-review
pr-self-review 是用于私下起草简短 PR 评审说明的工作流,聚焦行为变化、受影响的调用方和不明显的选择。它要求以证据为依据,并在向 GitHub 发布前获得批准。
主要功能
- 01核实 PR 与作者信息
- 02检查差异、讨论和调用方
- 03起草简洁且有依据的说明
- 04发布前要求批准
- 05核验已发布内容并避免重复
适用场景
- 01为现有 PR 准备说明
- 02没有开放 PR 时检查本地改动
- 03向评审者解释行为变化
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ petekp/ claude-code-setup --skill pr-self-review安装后在 Claude Code 中输入/pr-self-review确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
references/github-posting.mdtarget.mdwriting-notes.md详细介绍
PR 自我审查备注
帮助队友了解行为变更、受影响的调用方及不明显的设计选择的草稿备注。此工作流授权检查和起草,不授权进行额外代码更改或回复队友。
对于现有 PR,请阅读 目标和作者身份,以核实仓库、开放的 PR、作者和当前提交头。没有 PR 时,请检查本地差异,并继续撰写仅供内部使用的草稿。
阅读差异、现有讨论和受影响的使用方。必要时查看历史记录或相关问题,以支持说明。针对有实质意义的变更,涵盖不同的审查问题;备注数量没有最低或上限要求。复杂的变更可能需要几条简短备注,简单的变更也可能不需要备注。
选择或起草说明时,请参考 撰写备注。每条备注都要简短、具体且有依据。不要臆测作者的意图,也不要以 Pete 本人的口吻发言。若需要添加持久的代码注释,请单独标出,除非已获授权修改该注释。
发布前,展示所有拟公开的文字:可选的审查摘要,然后是每条备注的路径、位置(左侧或右侧)、行号和正文。将支持性证据放在拟发布的评论之外。如果所有有用的要点都能以内联评论表达,摘要写作 none;不要添加评论数量或状态公告。
等待对措辞和锚点的批准。收到确切文本并附有发布指令,即视为批准;不要重复询问。如果需要更改已批准的措辞或锚点,请先展示更改并获得批准。每次运行时都要检查现有评论,避免重复。
获批后,阅读 GitHub 发布说明。将已批准的备注作为一条审查发布,并确认 GitHub 保存了预期的文本和锚点。作者身份不符、PR 已关闭或缺少批准时,不要发布。可以继续撰写仅供内部使用的草稿。