用途:在需要创建 Pull Request(PR)时使用,帮助生成的 PR 符合仓库既定模板与标准。
主要能力与流程:
- 分支管理:先运行 git branch --show-current 确认当前不在 main 分支;若在 main,必须新建并切换分支:git checkout -b <new-branch-name>。
- 提交更改:用 git status 检查未提交内容,如有则暂存并提交,提交信息采用描述性格式:git add . 与 git commit -m "type(scope): description"。绝不直接提交到 main。
- 查找模板:检查 .github/pull_request_template.md 与 .github/PULL_REQUEST_TEMPLATE.md;若存在多个模板(如 .github/PULL_REQUEST_TEMPLATE/ 下),询问用户选择或按上下文选取最合适的。
- 读取模板并起草描述:严格遵循模板结构,保留所有标题;逐项核对清单,已完成标 [x],不适用则保持未勾选或按模板说明处理;填写清晰简洁的变更摘要,并关联相关 issue(如 "Fixes #123")。
- 预检:创建 PR 前运行 npm run preflight,确保构建、lint 与测试通过,失败则先修复。
- 推送分支:再次确认当前分支不是 main,然后执行 git push -u origin HEAD。
- 创建 PR:使用 gh CLI,为避免多行 Markdown 的 shell 转义问题,先将描述写入临时文件,再执行 gh pr create --title "type(scope): succinct description" --body-file <temp_file_path>,最后删除临时文件。标题在仓库使用 Conventional Commits 时需遵循该格式。
原则:安全第一,绝不推送到 main;遵守模板;完整填写相关部分;不勾选未实际完成的任务。
适用场景:需要按仓库规范创建 PR 的 Git 工作流。
限制:资料未提供该技能的具体安装方式、支持平台、收费信息或额外配置说明。