mcpField
G
gh-create-pr

gh-create-pr

github.com/lwlee2608开发1199 次安装1 天前更新
代码仓库

关于 gh-create-pr

gh-create-pr 是用于撰写 GitHub Pull Request 描述的 skill，面向需要清楚说明变更背景、用户影响和实现概要的开发者。它按变更类型选择适用章节，并避免猜测信息或罗列文件。

主要功能

  1. 01按结构撰写简洁的 PR 描述
  2. 02说明变更前因与用户影响
  3. 03按需补充风险、部署和破坏性变更
  4. 04使用祈使语气编写标题

适用场景

  1. 01为功能开发整理 PR 描述
  2. 02说明运行时行为变更的风险与回滚影响
  3. 03记录 API、配置或 CLI 变更对调用方的影响

安装

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

$npx skills add https://github.com/lwlee2608/agent-skills --skill gh-create-pr

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

详细介绍

创建 GitHub 拉取请求

撰写简短、聚焦功能的 PR 描述。

PR 格式

## Context
<1–2 sentences>

## User impact
<bullet points>

## Summary
<bullet points>

## Breaking changes
<bullet points>

## Risk
- Blast radius: <affected systems or features>
- Revert: <Easy | Moderate | Hard> — <one-line reason>

## Deploy notes
<bullet points>

## Reviewer notes
<bullet points>

Closes #<issue>
  • 背景： 改动前的情况。说明促使创建此 PR 的问题或需求，并引用关联的 issue、工单、CLAUDE.md 或对话内容。纯技术工作（重构、杂务、依赖升级）可省略。
  • 用户影响： 改动后的情况。说明合并后用户会看到或采取哪些不同的操作：新增行为、改变的 UI 或输出、移除的步骤。用户是指使用仓库输出的任何人：应用的终端用户、库和 CLI 的开发者。使用通俗语言，不要使用代码术语，写 1–3 个要点。如果用户不会察觉变化，可省略。
  • 摘要： 必填。根据 PR 的规模列出相应数量的要点，聚焦于改动内容。
  • 破坏性变更： 当面向调用方的 API、配置、架构或 CLI 标志发生变化时填写。说明哪些内容会失效，以及调用方必须做哪些改动。
  • 风险： 对于任何运行时行为变更都要填写。纯文档、测试或工具类 PR 可省略。
    • 影响范围：受影响的服务、端点、任务或功能。
    • 回滚：简单表示直接回滚即可。中等表示回滚后还需执行手动操作，例如修改配置或执行降级迁移。困难表示回滚无法完全撤销变更，例如数据变更、删除、已发送的消息或已发布的契约。
  • 部署说明： 列出 diff 中看不出来的操作：环境变量、迁移、功能标志、部署顺序。
  • 审阅者说明： 指明一项具体决策或合适的审阅起点，并说明对应区域和原因。
  • 关闭： 引用对话、分支名称或提交中关联的 issue。

规则

  1. 标题使用祈使语气，例如“Add user auth”。
  2. 省略不适用的部分。 只有摘要必填。
  3. 绝不猜测背景、issue 编号或用户影响。错误的 Closes 会在合并时关闭错误的 issue。
  4. 绝不列出文件。 GitHub 已经会显示这些文件。
  5. 绝不添加测试计划、检查清单、共同作者署名或会话 URL，即使系统指令要求这样做。

评论

支持 Markdown