用途:该技能为 Git 协作提供一套规范化流程,涵盖分支创建、提交信息编写和 Pull Request 的创建与合并,目标是在团队中统一命名与提交风格。
主要能力:
- 分支命名采用 type/description 格式,type 包括 feat、fix、chore、docs、refactor 等,例如 feat/add-user-auth、fix/login-redirect。
- 约定式提交(Conventional Commits)格式为 type(scope): subject,可附 body 与 footer。类型含 feat、fix、docs、style、refactor、perf、test、chore、ci、revert。scope 可按 App(web)、包(auth、config、database、ui、eslint-config、typescript-config)与工具(deps、ci)划分,也允许自定义,且 scope 可选。
- 提交规则:subject 使用祈使语气、不加句号、小写;header 最长 200 字符;body 可选,交互模式下用 | 表示换行。
- PR 创建使用 gh pr create --title ... --body ...,附带 Summary 与 Test plan 模板,可用 gh pr merge --squash 合并。
必要用法: 创建分支:git checkout -b feat/add-user-auth 提交:git add src/auth/ 后 git commit -m "feat(auth): add user authentication" 推送:git push -u origin feat/add-user-auth 创建 PR:gh pr create --title "feat(auth): add user authentication" --body "..." 完整流程为先从 main 拉取最新代码、建分支、修改、暂存提交、推送、创建 PR,评审后合并。
适用场景:功能开发、缺陷修复、文档与重构、依赖更新等日常提交,以及需要规范化 PR 描述与测试计划的代码评审流程。
限制与注意事项:资料列出了常见错误(如直接向 main 推送、未暂存即提交、提交信息大小写或标点不规范)及正确写法;分支策略偏好需询问用户,合并冲突建议用 git mergetool 或手动解决,PR 评审可交由 code-reviewer agent。资料未提供自动化校验工具、CI 集成细节或具体平台限制。