关于 ship-pr
ship-pr 是用于准备代码仓库变更并提交拉取请求的技能,面向协调实现、验证与交付的开发者。它强调遵循项目约定、执行范围明确的检查,并将 PR 准备与发布或自动审查分开。
主要功能
- 01检查分支、变更和项目指引
- 02追踪行为变更涉及的文件
- 03更新文档与发布说明
- 04撰写基于证据的 PR 描述
- 05运行检查并明确暂存路径
- 06在请求范围内创建 PR
适用场景
- 01为功能分支准备拉取请求
- 02更新代码变更影响的文档
- 03提交前验证并暂存负责的文件
- 04使用 gh 创建或更新指定的 PR
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ pedronauck/ skills --skill ship-pr安装后在 Claude Code 中输入/ship-pr确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
references/coderabbit-watch.mdcommit-conventions.mdexplore-impact.mdpr-description.mdqa-artifacts.mdrelease-notes.mdscripts/detect-tooling.sh详细介绍
提交 PR
按照仓库惯例完成所请求的交付范围。复用实现的影响分析、当前检查和 QA 证据。除非用户要求或项目要求,否则不要把准备 PR 变成发布或自动化审查流程。
- 检查分支/基分支、已暂存和未暂存的更改、相关说明、PR 模板和当前验证情况。已提交的工作也可作为有效输入。不要将无关更改加入暂存区。
- 追踪已更改的公开行为及其受影响的文档、示例、配置和发布说明。可在本地检查范围明确的差异;只有在不同的大型领域确实需要时,才借助有限范围的独立 Agent。
- 更新受影响的文件。遵循仓库的发布说明政策;PATH 中存在某个二进制文件,并不能证明仓库已采用它。将相关更改归组,而不是每个要点都单独写一条说明。
- 围绕最终行为、重大风险和实际验证情况撰写 PR 描述。使用仓库模板;省略空的可选部分。仅在有助于说明更改时,才附上现有 QA 产物。
- 提交前,运行必需的定向门禁,或按项目政策复用有效证据。明确暂存自己负责的路径,并检查暂存差异。遵循 commitlint 和钩子要求;不得虚构模型署名、改写历史或绕过钩子。
- 如果用户的请求包含提交、推送或创建 PR,则发布功能分支,并使用
gh和正文文件创建或更新 PR。遵循用户要求的草稿状态。持续跟进必需的 CI,直至当前 HEAD;出现失败时进行排查。 - 仅在用户要求,或外部审查监控器已属于获准交付流程时,才启动该监控器。确认已安装的命令和已配置的提供方。自动修复、提交、推送和无限轮询都是独立的范围选项,不应仅因检测到工具就默认执行。
参考资料
按需加载相应阶段的详细说明:references/explore-impact.md、references/release-notes.md、references/pr-description.md、references/qa-artifacts.md、references/commit-conventions.md 或 references/coderabbit-watch.md。
只读检测器为 bash <ship-pr-dir>/scripts/detect-tooling.sh,相对于此技能解析路径。PATH 检测结果仅表示工具可用,不代表已获授权或已配置项目集成。缺少可选集成不会阻碍常规 PR 流程。仅对已配置且存在受影响规范文件的仓库同步 Skeeper。
评论
支持 Markdown