SuperAPI AI 工具集

create-pr

编程与开发

查看项目

更新于 10-16 10:19

技能介绍

create-pr 是一份关于如何使用 GitHub CLI 在项目中创建拉取请求(PR)的指南,重点在于规范 PR 的模板与格式。

【用途】 帮助开发者通过 GitHub CLI(gh)按项目规范创建和管理拉取请求,确保标题格式、描述模板和语言风格统一。

【主要能力】

  • 说明创建 PR 的前置准备:检查 gh 是否安装,未安装时给出安装方式。
  • 提供创建 PR 前必须进行的预检查流程。
  • 给出创建 PR 的命令结构与参数用法。
  • 给出 PR 标题与描述的最佳实践。
  • 提醒常见错误。
  • 汇总其他常用的 gh pr 管理命令。

【前置条件】 检查 gh 是否已安装,若未安装则按说明安装:

macOS: brew install gh

Windows: winget install --id GitHub.cli

Linux: 按 https://github.com/cli/cli/blob/trunk/docs/install_linux.md 中的说明操作。

随后进行 GitHub 认证: gh auth login

【预检查】 创建 PR 前先检查是否有未提交改动:运行 git status 查看已暂存、未暂存或未跟踪的文件。若存在未提交改动,先使用 Skill 工具运行 commit 技能(Skill: commit),确保在创建 PR 前所有工作都已提交。

【创建拉取请求】 先按 @.github/pull_request_template.md 中的模板准备 PR 描述。

使用 gh pr create --draft 创建新的拉取请求:

基本命令结构: gh pr create --draft --title "✨(scope): Your descriptive title" --body "Your PR description" --base main

对于格式要求更复杂的描述,使用 --body-file 选项并采用精确的 PR 模板结构: gh pr create --draft --title "✨(scope): Your descriptive title" --body-file .github/pull_request_template.md --base main

【最佳实践】

  • 语言:PR 标题和描述一律使用英文。
  • PR 标题格式:采用带 emoji 的约定式提交格式;标题开头始终包含合适的 emoji;使用实际的 emoji 字符(而非 :sparkles: 这类代码表示)。示例: ✨(supabase): Add staging remote configuration 🐛(auth): Fix login redirect issue 📝(readme): Update installation instructions
  • 描述模板:始终使用来自 @.github/pull_request_template.md 的 PR 模板结构。
  • 模板准确性:PR 描述必须严格遵循模板结构;不要修改或重命名 PR-Agent 区块(pr_agent:summary 与 pr_agent:walkthrough);保持所有区块标题与模板中完全一致;不要添加模板中不存在的自定义区块。
  • 草稿 PR:工作进行中时先创建为草稿,命令中使用 --draft 标志;完成后用 gh pr ready 转为可供审阅。

【常见错误】

  • 使用非英文文本:所有 PR 内容必须使用英文。
  • 区块标题不正确:始终使用模板中的精确区块标题。
  • 添加自定义区块:只使用模板中定义的区块。
  • 使用过时模板:始终参考当前的 @.github/pull_request_template.md 文件。
  • 缺少区块:始终包含所有模板区块,即使某些内容标记为 "N/A" 或 "None"。

【其他 GitHub CLI PR 命令】 列出你开启的拉取请求: gh pr list --author "@me"

检查 PR 状态: gh pr status

查看指定 PR: gh pr view <PR-NUMBER>

在本地检出 PR 分支: gh pr checkout <PR-NUMBER>

将草稿 PR 转为可供审阅: gh pr ready <PR-NUMBER>

为 PR 添加审阅者: gh pr edit <PR-NUMBER> --add-reviewer username1,username2

合并 PR: gh pr merge <PR-NUMBER> --squash

【使用模板创建 PR】 为简化 PR 创建并保持描述一致,可以创建模板文件:

  1. 创建一个名为 pr-template.md 的文件并写入你的 PR 模板。
  2. 创建 PR 时使用它: gh pr create --draft --title "feat(scope): Your title" --body-file pr-template.md --base main

【相关文档】

  • PR Template
  • Conventional Commits
  • GitHub CLI documentation

【限制】 资料未提供该技能的具体安装命令(除 gh 本身的安装外)、支持的平台范围、收费或价格信息。