用途
commit-msg 用于为 Yakit 仓库完成一次本地提交:确定提交范围、基于 diff 归纳中文提交信息、经用户确认后执行 git commit,不执行推送。message 是对改动意图的概括,而非逐文件罗列;多行 message 仍用于同一次提交。
主要能力
流程会先确认提交范围。若用户只需要 message,只读分析 git status --short 与 git diff --cached;有暂存内容时以暂存区为准,否则读取工作区 diff 及未跟踪文件内容;没有改动则说明并停止,有改动则完成归纳后只输出 message,跳过暂存、确认与提交。
提交范围确定:记录 git rev-parse HEAD,读取 git status --short 与 git diff --cached,不能只靠文件名判断。暂存区非空时只提交暂存内容,不 add 其他未暂存改动;暂存区为空而工作区有改动时,展示文件清单并请用户确认「暂存全部改动,继续预览提交信息」(git add -A)或「取消,不提交」,未同意前不执行 git add;两者都空则报告无可提交改动并停止。
信息风格对齐:通过 git log -10 --format='%h%n%B' 读取完整历史 message,贴近仓库习惯,不强行套用 Conventional Commits;新提交优先使用 type: subject 形式。
按类型归纳:检查选定范围的全部改动并按实际意图分类。单一类型生成一行中文 message;同时存在 feat、fix、refactor 等多个类型时,每种类型各占一行,同类改动合并概括,同一项改动不重复列出多个类型。
提交确认:展示完整 message(保留换行)与文件清单,提供「确认提交」与「取消」;Other 输入视为修改 message,重新展示并确认。未获得覆盖当前范围与 message 的明确授权不得执行 git commit。
提交与核验:提交前重新读取 HEAD 与暂存 diff,确认暂存区非空且范围、内容与已确认版本一致;若变化则重新归纳并确认,若已空则报告并停止。记录提交前 HEAD,将完整 message 按实际换行写入临时文件后执行 git commit -F <文件>,无论成功失败都删除临时文件;禁止使用 git commit -m。随后用 git rev-parse HEAD、git diff --cached 与 git status --short 核验,只有命令成功、HEAD 已前移且暂存区为空才返回 COMMITTED,附 SHA 与实际提交文件清单;失败则返回 FAILED,报错原文或检查结果加实际 git 状态,不隐藏、不自动重试。流程不推送。
使用方式
通过语义触发(如用户说「提交」「commit 代码」)、输入 /commit-msg 或被其他 skill 调用时走完整流程。用户表述为「仅要 message」「写 / 生成 commit message」等时只输出文本。用户已给出 message(如「用 fix: xxx 提交」)时跳过生成,仍检查提交范围并按确认规则提交。交互使用当前环境可用且允许用于该用途的工具(如 AskUserQuestion / request_user_input_async);没有合适工具时在对话中询问;异步问题未收到回答不算确认;当前会话已明确授权的同一范围与操作不重复询问,仅提供 message 不代表授权暂存全部改动。
终态
COMMITTED:成功,附 SHA 与文件清单,HEAD 已前移、暂存区已清空。CANCELLED:用户取消,核验并报告 HEAD 是否变化及暂存区与工作区实际状态;已同意的暂存操作可能已完成,保留其结果,不自动撤销。FAILED:暂存、commit 或提交后核验失败,附报错原文或未通过的检查,以及当时 HEAD、index 与工作区状态;hook 可能留下部分改动,不得谎称已恢复。
Message 规范
每行使用 <type>: <subject> 或 <type>(<scope>): <subject>,无明确 scope 则省略(Yakit 多数无 scope)。单一类型保持一行,多种类型直接换行分隔,主要改动放在第一行。使用祈使语气(添加 / 修复 / 更新 / 优化),中文为主,术语与组件名保留英文;每行无句号,尽量不超过 72 字符(中文按 2 计)。禁止 WIP、misc、update files、修改、调整,不手写 (#PR号)。type 取值包括 feat(新功能 / 页面 / 选项)、fix(用户可见行为修正)、perf(性能)、refactor(重构,行为不变)、style(样式 / UI,无逻辑变化)、docs(文档,含 AGENTS.md、README、注释)、test(测试)、build(构建 / 依赖 / Vite / electron-builder)、ci(CI)、chore(脚本、工程化、版本号)。scope 例:webfuzz、agents、renderer、electron、aiAgent、License。
示例
单行 message 示例(每行分别代表一次提交): feat: 添加支持多子Agent的配置选项 fix: 暗色主题下关闭记事本时内容区闪白 docs(agents): 完善启动指南的依赖检查与用户决策弹框交互 build(renderer): 将主渲染端与 Link 从 CRA/Vite6 迁移至 Vite 8
同一次提交包含多个类型时: feat: 添加 AI 会话连接取消与重试功能 fix: 修复关闭会话时丢失排队消息的问题 refactor: 提取共享的会话启动逻辑
适用场景与限制
适用于 Yakit 仓库的本地提交整理与执行,尤其需要按类型归纳中文 message、多类型改动合并成多行 message 的场景;也被 create-pr 等调用方使用,create-pr 仅在 COMMITTED 且实测 HEAD 前移、git diff --cached 为空时继续。限制:仅针对 Yakit 仓库流程;不做推送;临时文件方式提交,禁止 git commit -m;确认与授权要求严格,未获得明确授权不提交;失败不自动重试。