SuperAPI AI 工具集

git-commit-workflow

编程与开发

查看项目

更新于 11-11 02:10

技能介绍

用途

本技能面向 Git 提交环节,为提交信息规范、暂存实践与提交流程提供指导,核心是使用 Conventional Commits 标准格式与显式逐文件暂存工作流。

主要能力

  • Conventional Commits 格式:标准格式为 type(scope): description,可附带正文与页脚。提交类型包括:feat(新功能)、fix(缺陷修复)、docs(文档)、style(格式调整,无代码逻辑变化)、refactor(重构,不改变行为)、test(测试)、chore(维护任务、依赖更新、linter 修复)、perf(性能优化)、ci(CI/CD 变更)。
  • 提交信息最佳实践:使用祈使语气(“add feature”而非“added feature”),首行不超过 72 字符,简洁客观;始终引用相关 Issue,使用 Fixes/Closes/Resolves 等关闭关键字,用 Refs #N 引用但不关闭;type 与 scope 用小写。
  • scope 建议:按功能领域(auth、api、ui、db)、组件(header、footer、sidebar)或基础设施(deps、ci、docker)划分。
  • 显式暂存流程:用 git status --porcelain 查看状态,逐个 git add 文件,用 git diff --cached --stat 与 git diff --cached 复核后再提交。
  • pre-commit 钩子集成:钩子可能自动修改文件(格式化、lint 自动修复)属正常行为;执行 pre-commit run --all-files --show-diff-on-failure 后检查 git status --porcelain,用 git add -u 暂存被修改的已跟踪文件,再次运行确认退出码为 0 后提交。退出码 0 表示全部通过,1 表示钩子失败或文件被修改。
  • 逻辑分组提交:将相关变更按核心实现、测试、文档、格式化等分组分别提交,便于审阅与回滚。
  • GitHub Issue 引用:支持 #N、GH-N、owner/repo#N 等自动链接格式;close、fix、resolve 及其变体可在合并到默认分支时自动关闭 Issue,其他分支仅建立链接。
  • 故障处理:误暂存用 git restore --staged;改提交信息用 git commit --amend(推送后用 --force-with-lease);漏加文件用 git add 加 --amend --no-edit;拆分提交用 git reset --soft HEAD~1 后分组暂存提交;部分暂存用 git add -p。

使用方式

按“查看状态 → 运行 pre-commit → 逐文件暂存 → 复核差异 → 规范提交 → 验证”的流程操作。示例:git add src/auth/login.ts、git commit -m "feat(auth): implement OAuth2 integration"。

适用场景

需要统一团队提交风格、保持提交历史清晰可追溯、将格式化改动与功能改动分离、规范关联 Issue 的项目。

限制

资料注明:提交在 main 分支进行,并推送到远程 feature 分支用于 PR,主分支开发模式参见 git-branch-pr-workflow 技能。资料未提供安装命令、收费、平台支持等信息,暂未提供。