SuperAPI AI 工具集

writing-pull-requests

写作与研究

查看项目

更新于 10-16 01:08

技能介绍

用途:撰写或审查 PR/MR 描述正文,也可用于审计已有描述,或在其中嵌入截图与视频。

主要能力与原则:

  1. 必要性测试:每句话都要问评审者能否从 30 秒扫 diff 中得到;能则删。不要复述类定义、调用方改动、签名变化或“无行为变更”等 diff 已表达的内容。保留 diff 看不到的信息,如“Stacked on #200. Merge that first.”或哨兵值语义说明。
  2. 首句给结论:第一句回答“为什么存在”,而非“做了什么”。
  3. 篇幅匹配改动量:机械性改动(重命名、格式化、依赖升级、删死代码)只需几句话,说明理由与“无逻辑变更”,例外按类别概括而非逐文件列举;只有各 hunk 真正不同时才用多段与逐条列举。
  4. 显式列出非显而易见之处,每条附安全结论(如“; safe”“; nothing changes”)。
  5. 删除:评审者已知的上下文回顾、前后对比、复述代码注释、道歉与铺垫、无信号模板、营销词。

格式规则:GitHub 在 issue、PR、discussion 字段中把段落内单个换行渲染为 <br>,因此每个段落或列表项写成一行,块之间空行;该规则适用于粘贴进评论式字段的内容,仓库内 Markdown 文件正常渲染,提交信息仍按 72 列换行。

嵌入媒体:需嵌入截图或视频时阅读 MEDIA.md;选择 URL 前用 gh repo view --json isPrivate 检查仓库可见性,私有仓库的 raw.githubusercontent.com 图片不会渲染。

限制:资料未提供该技能的安装方式、支持平台、收费或价格信息。