SuperAPI AI 工具集

commit-work

编程与开发

查看项目

更新于 10-15 14:34

技能介绍

用途

commit-work 用于创建高质量、易于审查且安全发布的 Git 提交。它强调三点:只包含预期的改动、提交按逻辑范围拆分(必要时拆分)、提交信息清楚描述改了什么以及为什么改。

主要能力

  • 暂存前检查工作区:使用 git status、git diff(未暂存)查看改动;改动较多时使用 git diff --stat。
  • 决定提交边界:按功能与重构、后端与前端、格式与逻辑、测试与生产代码、依赖升级与行为变更等维度拆分。若同一文件内混合了不同改动,计划使用补丁暂存。
  • 只暂存属于下一次提交的内容:优先使用 git add -p 进行补丁暂存;取消暂存可用 git restore --staged -p 或 git restore --staged <path>。
  • 审查实际将提交的内容:使用 git diff --cached,并做安全检查,包括无密钥或令牌、无意外调试日志、无无关格式变动。
  • 在写提交信息前,用 1-2 句话描述暂存的改动(改了什么 + 为什么)。如果无法清晰描述,说明提交可能过大或混杂,应返回上一步重新拆分。
  • 编写提交信息:要求使用 Conventional Commits,格式为 type(scope): short summary,空行后接正文(说明 what/why,而非实现日记),必要时添加 footer(如 BREAKING CHANGE)。多行信息建议使用编辑器:git commit -v;可参考 references/commit-message-template.md。
  • 运行最小相关验证:在继续之前运行仓库中最快且有意义的检查(单元测试、lint 或构建)。
  • 重复上述流程,直到工作区干净。

使用方式

该技能以清单式工作流引导操作,需要用户提供或确认的输入包括:单次提交还是多次提交(若不确定,存在无关改动时默认多个小提交)、提交风格(要求 Conventional Commits)、以及任何规则(如主题最大长度、必需的作用域)。执行过程中会使用一系列 Git 命令完成检查、暂存、审查和提交。

适用场景

适用于需要将工作区改动整理成规范、可审查的 Git 提交的日常开发流程,尤其适合改动混杂、需要拆分提交或需要遵循 Conventional Commits 规范的团队。

限制

资料未提供关于收费、价格、平台支持、具体效果或额外使用步骤的信息。