用途
creating-pr 用于把本地完成的工作打包成一个易于评审和合并的 Pull Request。它关注的是 PR 本身的组织质量:标题、描述、关联 issue、评审人,以及与分支整理相关的准备工作。
主要能力
该技能给出了一套从准备分支到请求评审的完整流程,包含以下环节:
- 准备分支:确保分支与基线同步(git fetch origin、git rebase origin/main 或按项目约定使用 merge);用 git log origin/main..HEAD --oneline 和 git diff origin/main --stat 检查将进入 PR 的内容;按项目偏好决定是压缩 fixup 提交还是保留细粒度提交。
- 撰写标题:格式为
<type>: <short description>。type 取值包括 feat(新功能)、fix(缺陷修复)、refactor(既不修 bug 也不加功能的代码改动)、docs(仅文档)、test(新增或修复测试)、chore(构建、CI、依赖或工具)、perf(性能改进)。示例:feat: add dark mode toggle to settings page;fix: prevent duplicate form submissions on checkout;refactor: extract auth middleware into shared module。 - 撰写描述:推荐结构包括 Summary(1-3 句说明该 PR 做什么、为什么)、Closes #123、Changes(列出具体改动,如新增 ThemeToggle 组件、更新 Layout 从 context 读取主题、将主题持久化到 localStorage)、Test Plan(以复选框列出验证项,如切换主题、刷新后主题保持、检查加载时无样式闪烁)。
- 自审:在请求评审前逐行阅读自己的 diff;移除调试代码(console.log、TODO、注释掉的代码);运行 npm test 验证测试、npx tsc --noEmit 验证类型、npm run lint 验证 lint;检查不应提交的文件(.env、lockfile 冲突)。
- 创建 PR:使用 git push -u origin HEAD 推送,再用 gh pr create 配合 --title 与 --body(body 通过 heredoc 传入 ## Summary、## Changes、## Test Plan 等段落)。
- 请求评审:指派合适的评审人(代码所有者、领域专家);若 PR 较大(>400 行),添加评论说明最佳的文件评审顺序;若依赖另一个 PR,在描述中注明;为 PR 打上合适标签(feature、bug、breaking change 等)。
使用方式
该技能以工作流说明的形式提供,包含具体的 git 命令与 gh CLI 命令示例,可直接按步骤执行。具体运行环境、安装方式与依赖条件暂未提供。
适用场景
适用于需要提交 Pull Request 的日常开发协作场景,尤其是团队对 PR 标题规范、描述结构、提交历史与评审流程有统一约定的项目。
限制
该技能提供的建议(如 PR 小于 300 行、过大时拆分为 stacked PR、UI 变更附截图或录屏、用 Draft PR 获取早期反馈)属于实践建议,具体采用与否取决于项目约定。文档未提供强制的自动化校验机制、平台适配范围或收费信息。