用途:为 GitHub PR 撰写或更新描述。读者是了解产品但没跟进这项工作的同事,应在其他任务间隙快速扫读,从加粗文字就能抓住重点。
主要能力与写法:使用仓库自带的 PR 模板标题;每个标题下用要点而非段落。每条要点以加粗引导语开头,用完整陈述句表达观点,仅在需要原因或后果时补一两句。一条要点一个观点,最重要的放最前,加粗标签可分组。正文控制在一屏、约 300 字(含测试);小改动一到三条即可。修订时在预算内重写整个正文,用正确行替换错误行,而不是逐条追加。
内容顺序(不适用可跳过):何处出错或缺失(有数字则给影响);改动做什么;合并后行为有何不同(含改动代码之外的影响);评审需检查的决策、风险或已知缺陷;本 PR 不包含什么(仅在读者会误解时);测试:验证了什么、未验证什么。省略逐文件叙述、问题如何发现、diff 已展示的机制、套话和刻意的文风。
证据:从所支撑的要点处链接证据(文档、仪表盘查询、源码行),不要另设章节。针对某行的推理放在 pr-self-review 的作者行内备注里,而非正文。截图、录屏等证明用 evidence selection。复用当前改动已做的验证,重要缺口放在其限制的主张旁边。
发布:用 gh pr create --body-file 或 gh pr edit --body-file,使用文件中的实际多行文本;随后重读保存的原始正文核对。对已有或新增图片、视频附件,读 attachment links,保留原始永久上传 URL,发布前及抓取原始正文后运行检查器,并检查渲染后的 PR;仅预览成功不能证明 URL 永久有效。切勿提交 PR 截图或在未获批准时上传。作者自评备注是使用 pr-self-review 的独立可选流程;发布描述不授权发表评论或回复同事。
限制:暂未提供该技能的安装方式、运行环境或其他平台兼容性信息。