SuperAPI AI 工具集

contextual-commit

通用与其它

查看项目

更新于 10-15 20:06

技能介绍

用途:让提交信息不仅记录“改了什么”,还承载“为什么改”。适用于提交代码、完成任务或需要保留开发推理的场景。

主要能力:主题行遵循 Conventional Commits 标准格式,正文使用 action-type(scope): description 形式的动作行。动作类型包括:intent 记录用户诉求与动机;decision 记录在存在备选时选择的方案及简要理由;rejected 记录被明确放弃的方案及原因(价值最高,可防止后续重复提议);constraint 记录实现中发现的硬性限制或依赖;learned 记录 API 怪癖、未文档化行为等经验。

使用方式:先运行 git diff --cached --stat 检查已暂存改动。若有暂存内容,则以暂存范围为提交范围,不考虑未暂存与未跟踪文件;若无暂存,则把未暂存修改和未跟踪文件作为候选,结合会话上下文决定提交内容。对有会话上下文的改动写完整动作行;对无上下文的改动只写 diff 能证明的内容,例如可见的技术选择可写 decision,但不可臆造 intent、rejected、constraint、learned。简单提交可只写 Conventional Commit 主题行,不强行添加动作行。

适用场景:功能开发、有目的的重构、架构迁移、实现中途转向,以及改动动机无法从主题行看出时。可与常规合并、squash 合并、rebase、cherry-pick 等标准 git 工作流配合,提交正文会被保留或拼接。

限制:动作行只写在正文,不写入主题行;只写有信号的内容,不重复 diff 已说明的信息;scopes 在项目内保持一致;intent 应体现用户原话诉求;rejected 必须说明原因。资料未提供安装命令、收费、价格与具体平台支持等信息。