SuperAPI AI 工具集

commit

编程与开发

查看项目

更新于 11-08 05:20

技能介绍

用途

commit 是 thoughtbot/rails-consultant 技能集中的一个技能,用于将当前工作区的更改提交为原子提交,并在提交信息中记录风险、权衡和考虑过的替代方案。它的核心目的是让提交历史成为智能体操作的审计日志,方便未来通过 git blame 追溯某行代码的来由。

主要能力

  • 检查工作区状态:使用 git status --porcelain -uall、git diff、git diff --staged、git log --oneline -15 查看当前更改和最近提交。
  • 筛选本次会话产生的更改:只提交本次会话产生的更改,不提交用户正在编辑的文件、临时脚本、含凭证的 .env 文件或日志等。无法确定归属的更改视为不属于本次会话,不提交。绝不提交看起来像秘密的内容。
  • 分组为原子提交:一个提交应是一个独立的变化,如果单独回滚该提交,剩余代码仍应合理且通过测试。功能即使跨十个文件也应作为一个提交;测试随代码一起提交;重构、bug 修复、依赖升级通常各自独立提交。不确定时倾向于更少的提交。
  • 精确暂存:使用 git add <paths> 添加整个文件,禁止使用 git add . 或 git add -A。如果一个文件包含两组更改,使用 git add -p 需要终端(当前环境没有),因此将相关差异块写入补丁文件并用 git apply --cached <patch> 暂存,每次提交前检查 git diff --staged。
  • 处理钩子:钩子会运行。如果钩子失败或重写文件,应报告其输出,不得绕过(禁止 --no-verify)、修改提交或推送。该技能只添加新提交。
  • 编写提交信息:
    • 主题行:祈使语气、首字母大写、无句号、约50字符,代码标识符用反引号。
    • 正文:空行后,每行72字符换行。以“为什么”开头,然后根据会话实际发现记录以下内容(通常一两条,也可没有):尝试并放弃的方案、风险、权衡、有意省略的内容、未检查的事项。
    • 写作风格:对话式,用“我们”而非“我”,使用缩写和短句;避免“this ensures”、“robust”、“it's worth noting”等;数字用阿拉伯数字(除非在句首);使用牛津逗号;不使用表情符号;不列出修改的文件;不要编造原因。
    • 琐碎更改(拼写错误、版本号、格式)只写主题行,无正文。
    • 每条提交信息末尾空行后附上本次会话通常添加的 co-author trailer,注明实际运行的模型。
  • 报告:显示新提交的 git log --oneline,并逐行说明值得注意的事项:做的拆分、未提交的文件及原因、钩子抱怨的内容。

使用方式

该技能作为 thoughtbot/rails-consultant 技能的一部分使用。用户或智能体调用该技能时,按照上述步骤执行提交操作。参数可以是上下文说明(如“处理评审反馈”),而不是字面提交信息。被要求提交时,直接做出决定并报告,不要停下来请求批准。

适用场景

适用于需要将当前更改提交到 Git 仓库的场景,特别是智能体在完成代码修改后需要生成符合规范、包含丰富上下文的提交信息时。也适用于团队协作中需要清晰审计日志的项目。

限制

  • 该技能只添加新提交,不修改已有提交或推送。
  • 无法处理需要交互式暂存的情况(如 git add -p),需改用补丁方式。
  • 不能绕过钩子。
  • 不提交不属于本次会话的更改。
  • 无法为未观察到产生过程的更改编造原因。
  • 需要终端环境支持 git apply --cached 等命令。