contextual-commits

为Git提交信息添加决策背景,让AI理解代码变更的“为什么”。

安装使用

复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:

帮我安装这个 AI Skill:contextual-commits。
它的用途是:为Git提交信息添加决策背景,让AI理解代码变更的“为什么”。
完整的 Skill 内容见:https://321skill.com/skills/contextual-commits/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。

使用示例

“请基于我们之前的讨论,实现用户登录功能,并使用Contextual Commits格式记录关键决策。” 它会生成包含`intent`、`decision`、`constraint`等标签的结构化提交信息,不仅提交代码,还将选择OAuth库的原因、遇到的API限制等背景信息一并固化在版本历史中。

介绍

Contextual Commits 解决了一个核心痛点:在AI编程时代,代码变更背后的决策、约束和尝试过的方案等关键上下文信息,会随着对话窗口的关闭而永久丢失。传统的提交信息只描述“改了哪里”,而这个Skill提供了一套结构化规范,让你能在提交信息的正文中嵌入“为什么这么改”的决策痕迹。

使用方式非常简单,无需安装新工具或改变基础设施。你只需要遵循其约定的格式,在git commit的正文部分,使用特定的“类型标签”(如intent、decision、rejected、constraint、learned)来结构化地记录你的意图、所做的决策、被否决的方案、面临的约束以及学到的经验。

它非常适合所有使用AI助手(如Claude、Cursor)进行编程开发的工程师,尤其是那些在复杂项目中需要维护长期技术决策记录、或需要与未来的自己或其他协作者(包括AI)共享开发上下文的团队。

建议在开始一个新功能模块或修复一个复杂问题时,有意识地使用这套规范来记录关键决策点。它不仅能帮助未来的AI助手避免重复探索,也能作为团队内部宝贵的知识沉淀。注意,它不要求你记录所有细节,而是聚焦于那些无法从代码本身推断出的“意图”和“历史尝试”。

核心特点

与仅规范“什么被改变”的Conventional Commits不同,Contextual Commits的核心是补充“为什么这样改变”。它通过一套可解析的结构化标签(intent, decision, rejected等),在提交信息中直接嵌入决策痕迹和约束条件,这是AI助手无法从代码差异中自行推断的关键上下文。

注意事项

不适合记录琐碎的、显而易见的变更,或用于替代详细的代码注释和设计文档。

常见问题

Contextual Commits 和 Conventional Commits 冲突吗?

不冲突,它是对Conventional Commits的补充,在提交标题遵循后者的同时,在正文中添加结构化背景信息。

需要安装什么特殊工具吗?

完全不需要。它只是一个书写提交信息的约定规范,不依赖任何特定工具或基础设施。

给 AI 助手的安装指引

如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:

请访问 https://321skill.com/skills/contextual-commits/raw/index.md 读取 contextual-commits 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。