约定式提交信息生成器

Conventional Commit Message Generator
分类编程
作者jeff-nasseri
许可MIT
评分4.10/5
使用16.1K

这个技能是什么

写代码最头疼的可能就是提交 Git 时,面对 git commit -m "fix bug" 这种敷衍的记录,过一个月自己都看不懂改了什么。这个技能能让 AI 直接根据你的 git diff 变更内容,自动生成符合 Conventional Commits(约定式提交) 规范的提交信息。它能帮你把杂乱的修改精准分类为 featfixrefactor 等类型,让你的提交历史像教科书一样清晰,不仅方便回溯,还能直接通过这些记录自动生成 Changelog。

适用场景

  • 面对一个巨大的 git diff,不知道怎么精炼地概括这次改动时。
  • 团队强制要求使用约定式提交规范,但你不想每次都花时间查规范格式。
  • 准备提交 PR 前,需要快速写一段专业且详尽的 Commit Message 来说明“为什么这么改”。
  • 整理冗长的开发分支,需要将多个小提交合并并重新写一个规范的总结。

如何使用

你只需要把 git diff 的输出内容(或者简单描述你改了什么)直接丢给 AI 即可。

markdown
你现在是一个约定式提交信息生成器。我会给你提供 git diff 的输出内容或变更描述,请你按照 Conventional Commits 规范生成提交信息。

格式要求:<type>[optional scope]: <description>

  • type 必须在以下范围内:feat (新功能), fix (修 Bug), docs (文档), style (格式), refactor (重构), test (测试), chore (琐事/维护), ci (CI 配置), perf (性能优化), build (构建系统)。

  • 如果有影响范围,请在括号内标注,如 feat(api):。

  • 如果是破坏性变更,请在 type/scope 后加 ! 或在 footer 中写 BREAKING CHANGE:。

  • description 必须使用祈使句、小写开头,且末尾不加句号。

  • Body 部分应解释“做了什么”和“为什么这么做”,而不是“怎么实现的”。

  • Footer 部分可包含 Refs: #123 等引用。

请直接输出最终的提交信息,不要包含任何解释性文字。

使用技巧

  • 配合命令行使用:你可以运行 git diff | pbcopy(Mac)快速复制变更内容,然后粘贴给 AI,效率最高。
  • 引导 Body 的深度:如果你觉得 AI 写的 Body 太简单,可以在输入 diff 时顺便提一句“这次改动是为了解决 XX 内存泄漏问题”,AI 会把这个背景写进 Body 里。
  • 微调 Scope:如果 AI 识别的 scope(范围)不准确,你可以直接要求它“把 scope 改成 (auth) 模块”,它会迅速修正。
  • 多文件处理:如果一次改动涉及多个模块,建议分批次给 AI 看,或者明确告诉它这次提交的核心目的,避免它把所有细节都揉在一起导致描述混乱。

注意事项

  • 敏感信息脱敏:在把 git diff 丢给 AI 之前,检查一下代码里有没有硬编码的 API Key 或数据库密码。
  • 核对准确性:AI 有时会误把 refactor(重构)识别为 feat(新功能),提交前一定要快速扫一遍,确保类型定义准确。