关于 pr-creator
pr-creator 是用于准备和创建 Pull Request 的 Agent Skill,涵盖分支与仓库检查、PR 文案和提交流程,并要求执行过程中不修改代码。
主要功能
- 01检查分支和本地更改
- 02遵循仓库的 PR 模板
- 03撰写简洁标题与说明
- 04通过 GitHub 连接器或 gh 提交
适用场景
- 01为已提交的更改准备 Pull Request
- 02避免在默认分支上提交或推送
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ rstackjs/ agent-skills --skill pr-creator安装后在 Claude Code 中输入/pr-creator确认已加载。
详细介绍
Pull request 创建器
步骤
-
使用
git branch --show-current确认当前分支。 如果当前位于默认分支,先创建并切换到新分支,再进行其他操作。 使用描述性分支名称,优先采用feat-<topic>或fix-<topic>。 -
使用
git status --short检查本地更改。 不要还原与任务无关的用户更改。 创建 PR 前,确保预期更改已提交,并且绝不要直接在默认分支上提交。 -
如果仓库提供 PR 模板,请阅读并遵循其中现有的标题和指南。
-
按照仓库的标准格式拟定 PR 标题。如果仓库使用 Conventional Commits,常见格式包括:
feat(core): add ...fix(types): ...docs: ...refactor(types): ...chore(ci): ...用于 CI 工作流、检查或发布自动化更改chore(deps): ...release: v1.2.0
-
使用简洁、清晰的英文撰写 PR 正文。
- 说明问题或动机及其重要性,然后描述所采用的方法和最终行为。
- 提供有助于审阅者评估更改的 API、兼容性或迁移信息。
- 通常将描述控制在几句简短的话内。聚焦关键更改,而不是逐个文件进行总结。
- 按照仓库指南或模板的要求,包含测试、文档和验证信息。否则,仅在这些内容对更改至关重要或与审阅风险相关时提及。
-
在相关背景旁附上相关议题、讨论或设计链接,并遵循模板指南。 对于依赖项升级,如有目标版本的发行说明或标签,请附上链接。
-
重新检查分支名称后再推送分支。绝不要直接推送默认分支。
-
创建 PR。 在 Codex 中运行时,使用 Codex GitHub 连接器/插件执行 GitHub 操作。 只有在连接器不可用时,才将
gh pr create作为后备方案。
限制
- 遵循此技能时,不要修改代码。
评论
支持 Markdown