SuperAPI AI 工具集

pr-description

编程与开发

查看项目

更新于 10-29 16:22

技能介绍

PR Description 是一个面向代码评审环节的技能,目标是把分支 diff 转化为结构清晰、信息完整的 PR 标题与描述,让评审者在一分钟内理解变更内容、原因、潜在影响和测试方式。

用途 它将开发者在分支上做出的改动整理成可直接用于 PR 的文本,减少撰写 PR 说明的时间,同时保证关键信息(变更点、影响范围、部署顺序、测试证据)不被遗漏。

主要能力

  1. 信息收集:通过 git fetch、git log、git diff --stat 和完整 diff 获取分支相对默认分支(不一定是 main)的提交与改动概况。
  2. 关联工单与背景:从分支名(如 ABC-123-...)或提交信息中提取 Jira 键,或直接询问;查找工单/PRD 以确认“为什么改”和验收标准;若存在影响分析报告或跨仓库变更计划,也一并纳入,用于判断影响范围和部署顺序。
  3. 遵循仓库约定:若存在 .github/pull_request_template.md,则按该模板填写,而不使用技能自带格式;标题也可按 git log 体现的仓库惯例(例如 conventional commits)调整。
  4. 生成内容结构:标题包含 Jira 键与变更摘要;正文先以一两句话说明动机,再列出评审者需要关注的变更点;按需给出影响范围、迁移/部署说明和测试情况;并提示评审时应重点关注的位置(如某文件某行的权限检查)。
  5. 写作风格约束:像同事之间沟通,不使用模板套话、表情符号,不逐行复述 diff;测试部分只写实际运行过的内容,不虚构测试或手工验证;UI 或 API 变更可在有帮助时附截图或示例请求/响应。
  6. 可选的开 PR 操作:先展示标题和正文,经开发者同意后执行 git push 与 gh pr create(可用 --body-file 提交正文、--base 指定目标分支、按需加 --draft);若已连接 Atlassian MCP 且开发者同意,可在 Jira 工单下评论 PR 链接。

使用方式 技能以分步流程组织:第一步收集 git 信息与背景资料;第二步按规则撰写标题和正文;第三步仅在用户要求时创建 PR。整个过程中,创建 PR 与在 Jira 留言都需要开发者明确同意。

适用场景 适用于需要提交 PR 的日常开发工作,尤其是涉及数据库迁移、跨仓库依赖、需要明确部署顺序,或团队要求 PR 说明关联 Jira 工单并说明影响范围的场景。也适合希望统一 PR 描述质量、降低评审沟通成本的团队。

限制 资料未提供该技能的具体安装方式、支持平台、收费模式或效果数据。其输出质量依赖仓库中可获取的信息(提交历史、diff、工单、PRD、影响分析报告等);缺少这些信息时,相关章节只能省略或标注暂未提供。技能本身不执行代码审查,也不保证测试真实性——测试部分须由开发者提供实际运行结果。第三方操作(gh 命令、Atlassian MCP)需要相应工具已配置并获授权。