SuperAPI AI 工具集
合作ENAI 行业资讯收藏
Skill 广场agent-pr-creator

agent-pr-creator

编程与开发

查看项目

更新于 10-16 02:14

技能介绍

用途

Agent PR Creator 用于自动完成 Pull Request 的创建流程。它通过分析 git diff 和提交历史，智能填写项目 PR 模板，并使用 gh CLI 创建 pull request。适用场景包括：用户要求为某个分支填写 PR 模板并创建 PR、需要为 PR 编写良好描述、向指定分支（如 main）发起 PR。

其目标是在创建 PR 时，依据提交与差异内容自动推断变更类型（feat/fix/refactor 等），检测破坏性变更，并按项目约定生成标题与正文。

主要能力

该技能的工作流分为多个阶段：

  1. 检测基准分支并检查是否已存在 PR：判断 PR 将指向的基准分支（如存在 develop 则用 develop，否则回退到 main）；查看当前分支；用 gh pr list 检查该分支是否已有 PR，若有则停止并询问用户是否改用 gh pr edit 更新描述。同时设置门禁：若有未提交更改或分支落后于远程，警告用户并停止。若分支没有远程追踪，先用 git push -u origin 推送。

  2. 分析变更：收集自基准分支以来的完整上下文，包括变更文件列表、提交日志、差异统计，以及可选的完整 diff。分析内容包括：修改了哪些文件及所属区域（前端、后端、测试、文档、配置）、提交数量、出现的约定式提交类型（feat、fix、refactor、test、docs、chore）、是否存在破坏性变更，以及本次变更是重构、新功能、缺陷修复还是组合。

  3. 读取 PR 模板：在标准位置查找项目 PR 模板（.github/PULL_REQUEST_TEMPLATE.md 等）。若找到，读取全文以理解所有必需章节（Description、Type of Change、Breaking Changes、Screenshots、Notes、Checklist）、确切的复选框标签与选项、以及项目特定约定。若未找到模板，则创建仅含标题与描述的最小 PR。

  4. 填写 PR 模板：

    • 标题：采用约定式提交格式，根据多数提交选择前缀（feat:、fix:、refactor:、docs:、test:、chore:），格式为 <type>: <short description>，保持在 70 字符以内，使用祈使语气（如 add、fix、update）。
    • 描述：分析 diff 与提交，写 2-3 句总结改了什么及为什么，聚焦业务价值而非实现细节；若涉及多个区域则按逻辑分组；若分支名或提交中存在 Linear/issue ID（如 PUL3-34、#123）则加以引用。
    • 变更类型：根据提交前缀勾选对应项（feat → New Feature，fix → Bug Fix，refactor → Code Refactoring，test → Tests，docs → Documentation，chore/build → Build/Config），使用 [x] 表示选中、[ ] 表示未选中，并沿用模板中的确切复选框标签，不重写或改写。可勾选多项。
    • 破坏性变更：分析是否修改了公共 API 契约、数据库 schema、环境变量、配置文件格式、移除的导出或公共方法。若有则勾选 Yes 并说明破坏内容与所需迁移步骤；若无则勾选 No。
    • 截图/视频：若变更涉及 UI 文件（src/components/、pages/、app/ 或 .jsx、.tsx、.vue 等扩展名），添加占位符注释；否则写 N/A — No UI changes。
    • 附加说明/清单：若存在非标准部署步骤（数据库迁移、环境设置、服务重启）、对其他 PR 或服务的依赖，或需要特定测试路径/边界情况，则加以说明；若无特殊事项则按模板风格写 N/A 或留空。

  5. 创建 PR：使用 gh pr create 并带上填写好的模板与标题，需保留模板的 markdown 格式，可用 shell HEREDOC（$'...'）或多行字符串维持章节分隔与格式。

  6. 确认与报告：创建成功后输出 PR URL、PR 编号、所含内容的简要总结（变更类型、受影响关键区域），并说明是否有自动分配的审阅者或特殊状态（草稿、可审阅）。

使用方式

该技能由匹配的触发语句激活，例如“fill the PR template and create a pull request for my branch”“I need to open a pull request with a good description”“Make a PR to main”。它依赖 gh CLI 与 git 命令执行。

非触发场景：审查已存在的 PR（应使用 gh pr view 或审查技能），或仅想查看分支中的变更（应直接使用 git diff 或 git log）。

适用场景与限制

适用场景：需要根据项目模板与提交历史自动生成结构化 PR 描述并创建 PR 的开发者工作流。

限制与常见问题：

  • 若用户措辞未匹配触发短语（如使用“review”“commit”而非“create PR”“open PR”“make PR”），技能可能不被选中；需改用明确的 PR 创建关键词重试。
  • 若找不到 PR 模板，则回退为仅含标题与描述的最小 PR。
  • 若该分支已存在 PR，gh pr create 会失败；应告知用户已有 PR URL 并询问是否用 gh pr edit 更新描述。
  • 若存在未提交更改或分支落后远程，需先提交（可使用 /commit）或暂存、先 pull 并 rebase。
  • 若分支无上游追踪，需先执行 git push -u origin <branch-name>。
  • 若 gh CLI 认证失败（未登录或令牌过期），需运行 gh auth login 重新认证后重试。

关于收费、价格、平台支持范围等信息，资料中暂未提供。