SuperAPI AI 工具集

pr-description

编程与开发

查看项目

更新于 11-16 13:44

技能介绍

用途: 该技能用于为 Pull Request(PR;在 GitLab 上称 Merge Request)撰写或检查描述,确保描述采用统一固定的格式。GitLab 与 GitHub 使用同一套格式。

主要能力:

  • 按模板生成完整 PR 描述。描述使用用户语言,或使用提示中指定的输出语言。
  • 当通过 CLI 或 API 创建 PR 时,不会自动带入仓库的 PR 模板,因此需要自行写全各章节;若仓库存在模板(GitHub 的 .github/pull_request_template.md、GitLab 的 .gitlab/merge_request_templates/),则保留其标题与检查清单,并把下述章节套入其中。
  • 中文版本保持相同章节与顺序,标题为:背景、改动(内含“行为变化:”,无则为“无”)、明确不改的、验证、回滚方式、未执行、关联。
  • 检查已有描述:同时阅读 PR 的 diff 与描述,报告缺失或空白的章节、diff 不支持的说法、diff 中存在但描述遗漏的行为变化,以及针对存储数据或配置变更缺少回滚方案的情况,并给出补充文本建议。

固定模板章节:

  • Background:问题、受影响对象、表现形式,并链接工单或讨论。
  • Changes:按机制而非文件列表说明改了什么;列出行为变化(用户可见或调用方可见的每项变化,无则写 None)。
  • Out of scope:审阅者可能预期但本 PR 明确不处理的内容及原因。
  • Verification:修复前失败、修复后通过的测试及名称。
  • Rollback:如何回滚,以及新版本写入的数据、配置或客户端会怎样。
  • Not done:未执行的检查,如某平台上的手工测试。
  • Related:关联信息。

规则要点:

  • 每个说法都应可核查;只有在核实后才能写“行为不变”,并说明核实方式。
  • 部署前置条件(DDL、配置中心变更、发布步骤)列在 Changes 下,并注明由谁执行。
  • UI 变更的前后截图或录屏放在 Verification 下。
  • Not done 要如实填写,审阅者会把缺失的检查视为待解问题。
  • MCode Review 在 L 和 XL 尺寸的 PR 以及触及风险路径的 PR 上要求提供验证与回滚章节;但建议每个 PR 都写全各章节。

使用方式与发布: 先展示文本,仅在用户要求时发布;先写入文件,然后:

  • GitHub:新建 PR 用 gh pr create --title "<title>" --body-file <file>,已有 PR 用 gh pr edit <n> --body-file <file>。
  • GitLab:glab mr create --title "<title>" --description-file <file>,或 glab mr update <n> --description-file <file>;不支持 --description-file 的旧版 glab 用 --description "$(cat <file>)"。 除非用户要求,不要修改 PR 的标题、标签、审阅者或目标分支。

适用场景: 提交新 PR 或更新已有 PR 描述、统一团队 PR 描述格式、在评审前自查描述与 diff 的一致性。

限制: 关于具体收费、平台支持范围等事实,资料未提供。