SuperAPI AI 工具集

keep-a-changelog

通用与其它

查看项目

更新于 10-16 01:19

技能介绍

用途:维护 CHANGELOG.md,让读者无需查看 diff 就能了解升级会对自身产生什么影响。代理维护 ## [Unreleased] 区段;仅在明确要求时准备版本区段,切版、打标签与发布由人决定。

主要能力:判断哪些变更值得记录——面向使用者有意义的变更,如公共 API 变更、新增或改变的行为、打包与安装变更、弃用、安全修复;通常不记录测试、CI 与工作流、内部工具、纯文档、纯格式与 lint、无可见影响的重构、无意义重命名。可准备版本区段,处理破坏性变更、回滚与撤回发布。

使用方式:编辑前先加载 references/spec-and-workflows.md,其中包含格式、类别、破坏性变更、回滚、撤回发布、条目风格、本仓库内部规则及两套工作流。可用校验脚本检查机械规则,它只校验不编辑:

python3 skills/keep-a-changelog/scripts/validate_changelog.py CHANGELOG.md python3 skills/keep-a-changelog/scripts/validate_changelog.py --house-rules CHANGELOG.md

判断要点:校验器无法替代两项判断——一条变更同时符合两个类别时,选其主导类别(重写同时修 bug,若重写是主线归 Changed,若修复是主线归 Fixed,不要两边都写);条目要真实且描述结果而非实现。每个标记为破坏性的提交(💥 / ! / BREAKING CHANGE: 页脚)都必须产生一条点名破坏点的条目,并暗示下一个版本为 MAJOR。若缺少提交信息线索,则从 diff 判断:移除或改变公共符号即为破坏性变更。

适用场景:为仓库维护变更日志、撰写发布说明、整理面向使用者的变更记录。

限制:产品代码边界需按各仓库自身布局(src/、cmd/ 加 internal/、lib/ 或包目录等)判断,不可套用其他仓库的边界。脚本不替代理做内容判断,也不会编辑文件。资料未提供具体安装步骤与收费信息。