SuperAPI AI 工具集

creating-pr

通用与其它

查看项目

更新于 10-15 19:48

技能介绍

用途:把已完成的工作打包成一个易于评审和合并的 Pull Request(PR),适用于使用 Git 与 GitHub 的团队协作流程。

主要能力与流程:

  1. 准备分支:先执行 git fetch origin,再按项目约定执行 git rebase origin/main(或 merge);用 git log origin/main..HEAD --oneline 和 git diff origin/main --stat 查看将进入 PR 的内容;按项目偏好决定是否压缩 fixup 提交。
  2. 编写标题:格式为 <type>: <short description>,类型包括 feat、fix、refactor、docs、test、chore、perf。
  3. 编写描述:采用 Summary(1-3 句说明做了什么与为什么,并用 Closes #123 关联 issue)、Changes(列出改动点)、Test Plan(勾选式测试项)三段结构。
  4. 自检:逐行阅读 diff,移除 console.log、TODO、注释掉的代码等调试内容;运行 npm test 验证测试、npx tsc --noEmit 验证类型、npm run lint 验证 lint;检查是否误提交 .env 或存在 lockfile 冲突。
  5. 创建 PR:执行 git push -u origin HEAD,再用 gh pr create --title "<title>" --body "$(cat <<'EOF' ... EOF)" 提交标题与正文。
  6. 请求评审:标记合适的评审人(代码所有者、领域专家);若 PR 超过 400 行,可评论说明建议的评审文件顺序;若依赖其他 PR 需在描述中注明;并添加合适标签。

适用场景:功能开发、缺陷修复、重构、文档与测试变更等需要走 PR 流程的代码提交。

限制与提示:资料未提供该技能的具体安装方式、平台支持范围或收费信息。建议保持 PR 小于 300 行改动以便更快评审,过大时拆分为堆叠 PR;UI 改动附截图或录屏;未完成工作可用 Draft PR 获取早期反馈。