SuperAPI AI 工具集

changelog

写作与研究

查看项目

更新于 10-15 21:35

技能介绍

用途:在需要生成或更新变更日志(changelog)条目时使用。核心目标是在 CHANGELOG.md 的 [Unreleased] 区块下产出符合 Keep a Changelog 格式的条目,用业务语言说明改了什么、对用户意味着什么,而不是罗列被修改的文件或类。

主要能力:通过 git diff 收集改动文件(支持 PR/分支、单次提交、区间三种模式);建立临时笔记文件 .ai/workspace/changelog-notes-*.md,按 Added/Changed/Fixed/Deprecated/Removed/Security 分类;逐文件审查业务影响;整体通读后按模块/功能分组写入条目;引用受影响逻辑 ID(FR-/BR-/TC-);破坏性变更以 BREAKING: 前缀加一行迁移/影响说明标注;最后删除临时笔记文件。

使用方式:先定位 CHANGELOG.md(优先 ./CHANGELOG.md,其次 ./docs/CHANGELOG.md,均无则在根目录创建),读取现有格式;用 git diff origin/develop...HEAD --name-only、git show {commit} --name-only 或 git diff {from}..{to} --name-only 获取改动范围;随后按上述步骤执行。

适用场景:发布前整理变更说明、维护面向用户的更新记录、需要将技术改动转写为业务影响描述的项目。

限制:资料未提供具体安装命令、收费方式或平台支持信息;该技能依赖 git 与项目文档结构(如 docs/project-config.json、docs/project-reference/ 等),若相关文档缺失或过期需先运行初始化流程;条目中不应出现类名、文件名等实现细节。