关于 create-draft-pr
用于将当前改动整理并提交为草稿拉取请求的技能。它指导 Agent 检查差异、提交并推送分支,再撰写简洁的 PR 说明。
主要功能
- 01检查状态、差异和提交历史
- 02在 main 上创建新分支
- 03提交并推送改动
- 04撰写 PR 说明
- 05使用 GitHub CLI 创建草稿 PR
适用场景
- 01将已完成的改动提交为草稿 PR
- 02确保 PR 说明遵循统一结构
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ jnsahaj/ skills --skill create-draft-pr安装后在 Claude Code 中输入/create-draft-pr确认已加载。
详细介绍
创建草稿 PR
提交所有更改、推送到远程,并创建带有精简生成说明的草稿拉取请求。
步骤
- 运行
git status查看更改 - 运行
git diff了解更改内容 - 运行
git log查看提交消息的风格 - 如果当前在
main分支上,按<initials>/<feature>格式或项目的分支命名约定创建新分支,然后切换到该分支 - 暂存并提交更改,提交消息应简洁
- 使用
-u标志将分支推送到远程 - 使用
pr-description技能的说明格式生成 PR 描述。 - 如果更改面向用户、涉及工作流或架构,请按照
ux-flow-plan的风格添加简洁的 UX 流程部分。 - 使用
gh pr create --draft创建草稿 PR - 如果你创建了分支(原先在
main上),创建 PR 后切回main
PR 正文格式
以 pr-description 技能的格式为基础:
## Summary
<One sentence describing the overall change>
- Additional note if needed
- Another note if needed
## Problem
Describe the issue being addressed. What was broken, missing, or suboptimal? Be specific about the root cause.
## Solution
Explain the approach taken to fix the problem. Include code snippets only when they clarify the core approach.
在适用时,于 Problem 和 Solution 之间添加此部分:
## UX Flow
```text
Current flow
└─ ...
Desired flow
└─ ...
```
仅在有助于说明产品行为、用户历程或架构边界时添加 UX Flow。保持简短,并使用 ux-flow-plan 的树状格式。
规则
- PR 标题应简洁(不要使用
feat:前缀,但修复 Bug 时可以使用fix:) - 使用
pr-description作为 PR 正文结构的唯一依据。 - 仅在相关时使用
ux-flow-plan中的UX Flow;机械性、依赖项或微小的内部更改不应添加。 - 不要逐文件总结代码更改。
- 不要使用带复选框的测试计划。
- 不要添加“Generated with Claude Code”或类似页脚
- PR 描述应简洁,并聚焦于意图和实现方式
- 使用 HEREDOC 编写 PR 正文,以保留格式
评论
支持 Markdown