关于 github-pr
用于借助 `gh` 创建和管理 GitHub Pull Request 的技能;命令行工具不可用时会提供手动操作指引。它涵盖分支检查、标题与描述撰写,以及标签和负责人设置。
主要功能
- 01检查 `gh` 安装与认证状态
- 02核对提交和目标基准分支
- 03拟定 Conventional Commits 格式标题
- 04根据提交和模板准备 PR 描述
- 05建议标签并指定负责人
适用场景
- 01完成特性分支后创建 PR
- 02`gh` 不可用时准备 PR 内容
- 03提交前核对 PR 所需条件
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ dhruvanbhalara/ skills --skill github-pr安装后在 Claude Code 中输入/github-pr确认已加载。
详细介绍
拉取请求的创建与管理
此技能会使用 GitHub CLI(gh)自动创建高质量的拉取请求;如果无法使用,则提供操作说明。
1. 准备工作
- 检查 GitHub CLI:确认已安装并通过身份验证(
gh auth status)。 - 检查提交:确保当前功能分支中的所有更改均已提交。
- 基础分支:确定目标基础分支(通常为
main)。
2. 拉取请求质量与元数据
- 质量门禁:所有拉取请求在合并前都必须通过分析(0 条警告)、格式检查和测试。
- 分支保护:确保遵守分支保护规则(不得直接推送到
main)。 - 元数据:务必指定相关标签和至少一位受理人。
- 检查清单:完成任务前,确保已审阅开发计划和需求。
3. 生成拉取请求标题
- 约定式提交:拉取请求标题必须遵循以下格式:
<type>(<scope>): <description>。- 类型:
feat、fix、docs、style、refactor、perf、test、build、ci、chore、revert。 - 示例:
feat(auth): add google sign-in support
- 类型:
- 来源:分析当前分支中的提交消息,以确定最合适的标题。
3. 生成拉取请求说明
- 提交历史:读取当前分支中的所有提交(
git log origin/main..HEAD --oneline)。 - 拉取请求模板:检查是否存在
.github/PULL_REQUEST_TEMPLATE.md或类似模板。如果存在,请填写该模板。 - 内容:
- 概述更改的“内容”和“原因”。
- 以项目符号列出具体更改。
- 包含任何相关的问题编号(例如,
Closes #123)。
4. 添加标签与指派受理人
- 可用标签:从仓库获取标签(
gh label list)。 - 自动添加标签:根据更改内容分配标签:
enhancement/feat:用于新功能。bug/fix:用于错误修复。documentation/docs:用于文档更新。
- 受理人:将拉取请求指派给当前用户,或遵循项目规则进行指派。
5. 执行
- 使用 CLI:如果可以使用
gh,请运行:gh pr create --title "<title>" --body "<body>" --label "<labels>" - 手动备用方案:如果无法使用
gh,请向用户提供生成的标题、说明和建议标签,并询问如何继续。
评论
支持 Markdown