mcpField
C
create-pr

create-pr

github.com/neolabhq开发1.8k1.2k 次安装9 周前更新
代码仓库

关于 create-pr

create-pr 是通过 GitHub CLI 创建拉取请求的技能，强调使用英语撰写内容、遵循仓库模板，并先以草稿形式创建。

主要功能

  1. 01检查 GitHub CLI 和认证状态
  2. 02检查并提交未提交的更改
  3. 03遵循仓库的 PR 模板
  4. 04使用 gh 创建草稿 PR

适用场景

  1. 01为进行中的工作创建草稿 PR
  2. 02按项目模板准备 PR 描述
  3. 03查看和管理未关闭 PR 的状态

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/neolabhq/context-engineering-kit --skill create-pr

安装后在 Claude Code 中输入/create-pr确认已加载。

详细介绍

如何使用 GitHub CLI 创建拉取请求

本指南介绍如何在我们的项目中使用 GitHub CLI 创建拉取请求。

重要提示：所有 PR 标题和描述都应使用英文撰写。

前置条件

检查是否已安装 gh；如果尚未安装，请按照以下说明进行安装：

  1. 如果尚未安装，请安装 GitHub CLI：

    # macOS
brew install gh

# Windows
winget install --id GitHub.cli

# Linux
# Follow instructions at https://github.com/cli/cli/blob/trunk/docs/install_linux.md

  2. 使用 GitHub 进行身份验证：

    gh auth login

创建前检查

创建 PR 前，请检查是否有未提交的更改：

  1. 运行 git status，检查是否有未提交的更改（已暂存、未暂存或未跟踪的文件）
  2. 如果存在未提交的更改，请使用 Skill 工具先运行 commit 技能： 
    Skill: commit
  3. 这样可确保在创建 PR 前，所有工作都已提交

创建新的拉取请求

  1. 首先，按照 @.github/pull_request_template.md 中的模板准备 PR 描述

  2. 使用 gh pr create --draft 命令创建新的拉取请求：

    # Basic command structure
gh pr create --draft --title "✨(scope): Your descriptive title" --body "Your PR description" --base main

    对于格式要求较高、内容更复杂的 PR 描述，请使用 --body-file 选项，并严格遵循 PR 模板结构：

    # Create PR with proper template structure
gh pr create --draft --title "✨(scope): Your descriptive title" --body-file .github/pull_request_template.md --base main

最佳实践

  1. 语言：PR 标题和描述始终使用英文

  2. PR 标题格式：使用带表情符号的约定式提交格式

    • 标题开头始终添加恰当的表情符号
    • 使用实际的表情符号字符（不要使用 :sparkles: 这样的代码表示形式）
    • 示例：
      • ✨(supabase): Add staging remote configuration
      • 🐛(auth): Fix login redirect issue
      • 📝(readme): Update installation instructions

  3. 描述模板：始终使用 @.github/pull_request_template.md 中的 PR 模板结构：

  4. 模板准确性：确保 PR 描述严格遵循模板结构：

    • 不要修改或重命名 PR-Agent 部分（pr_agent:summary 和 pr_agent:walkthrough）
    • 所有章节标题必须与模板中的内容完全一致
    • 不要添加模板中未定义的自定义章节

  5. 草稿 PR：工作尚未完成时，先创建草稿

    • 在命令中使用 --draft 标志
    • 完成后使用 gh pr ready 将其转换为可供审查的状态
应避免的常见错误
  1. 使用非英文文本：所有 PR 内容都必须使用英文
  2. 章节标题错误：始终使用模板中完全一致的章节标题
  3. 添加自定义章节：仅使用模板中定义的章节
  4. 使用过时的模板：始终参考当前的 @.github/pull_request_template.md 文件
缺少章节

始终包含模板中的所有章节，即使有些章节标注为 “N/A” 或 “None”

其他 GitHub CLI PR 命令

以下是一些用于管理 PR 的其他实用 GitHub CLI 命令：

# List your open pull requests
gh pr list --author "@me"

# Check PR status
gh pr status

# View a specific PR
gh pr view <PR-NUMBER>

# Check out a PR branch locally
gh pr checkout <PR-NUMBER>

# Convert a draft PR to ready for review
gh pr ready <PR-NUMBER>

# Add reviewers to a PR
gh pr edit <PR-NUMBER> --add-reviewer username1,username2

# Merge a 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

相关文档

评论

支持 Markdown