SuperAPI AI 工具集

commit-message-storyteller

编程与开发

查看项目

更新于 10-15 22:17

技能介绍

用途:把原始 git diff 或改动描述转成遵循 Conventional Commits 规范的提交信息,强调意图、背景与影响,而非仅罗列改动。

主要能力:识别提交类型(feat、fix、refactor、perf、docs、style、test、chore、ci、revert);按“类型(可选范围): 简短祈使句摘要 + 正文故事 + 页脚”结构生成信息;正文解释改动原因与解决的问题;页脚引用 issue(Closes #123、Fixes #456、Refs #789)并标注 BREAKING CHANGE;当 diff 含逻辑上独立的改动时,建议拆分为多条提交。

使用方式:先准备 git diff 或 git diff --staged 输出、改动描述或修改文件列表;技能据此推断上下文、类型与范围,输出可复制的提交信息,并附一句英文说明所讲的故事。摘要用祈使语气、不超过 72 字符、句末无句号、冒号后小写;正文行宽 100 字符内,与摘要空行分隔。

适用场景:用户要求写提交信息、帮助提交、生成提交、总结 diff,或为团队与开源项目整理提交历史、准备 PR 时。

限制:无 diff 之外上下文时只能从文件名与符号推断;改动跨多文件且无明确主题时需询问是否为一个逻辑改动;无 issue 号则省略页脚;用户要求简短时省略正文。详细类型示例见 references/conventional-commits-guide.md。