SuperAPI AI 工具集

git-workflow

办公与效率

查看项目

更新于 10-15 17:24

技能介绍

用途:为新任务创建 feature branch、判断何时 commit、撰写 commit message、在开 PR 前清理 branch 历史、创建 PR(Draft/Ready)、处理 review 反馈。不适用于与 commit/branch/PR 语义无关的普通 shell 操作,或仅用 git log / git bisect 调试历史。

主要能力与要求:

  1. 建 branch:不直接 commit 到 main。命令为 git fetch origin main --quiet 与 git switch -c <branch-name> origin/main。并行任务可用 git worktree add -b <branch-name> ../<task-dir> origin/main,并始终传入显式 base ref。
  2. Commit 纪律:atomic commit,每个只表达一个逻辑变更、可 build 并通过测试;不混 refactor 与 feature。message 用 Conventional Commits:<type>(<scope>): <summary>,body 解释 why,可选 ! 表示 breaking change。禁止提交 API key、build artifacts、本地配置、大二进制等。commit-reminder hook 在未提交 diff 超 200 行或 8 个文件且距上次提醒超 5 分钟时注入提醒,不阻塞。
  3. PR 前清理:用 git log --oneline main..HEAD 自检,wip/fixup 用 git rebase -i --autosquash main 折叠,message 不清用 reword。不为表面整洁 squash;不 force-push 已共享 branch。
  4. 创建 PR:描述需含 Scope、Acceptance Criteria、Design Decisions、Risks、Remaining TODOs,并推荐 ## Summary 等结构。用 gh pr create --draft 创建,pr-ready-guard 在缺 --draft 时会做结构性文档检查并可能阻塞。
  5. 创建后:pr-create-guard 检查 body heading、title 格式并提醒,不阻塞;可用 gh pr edit 修复。
  6. Ready 后:按批次用 gh pr comment --body-file 汇报 fixed/deferred/won't fix,不逐条回复评论,不用批量评论替代 commit message 理由。
  7. 合并:pr-merge-guard 在 gh pr merge 前检查 Acceptance Criteria 与 Test plan 未勾选项并阻塞;guard fail open。

限制:hooks 与各阶段规则需对应运行环境;未提供的价格、平台支持等信息暂未提供。