SuperAPI AI 工具集

changelog-generator

写作与研究

查看项目

更新于 10-16 01:18

技能介绍

用途:把原始 git 提交、diff 摘要或开发者发布说明,整理成面向用户的变更日志条目,遵循 Keep a Changelog 约定,适用于撰写发布说明、生成 CHANGELOG.md 条目或记录某版本变更。

必要输入:提交或发布说明(如 git log --oneline、原始提交信息或变更描述)、版本号(如 2.4.0、v1.0.0-beta.2)、发布日期(或“today”)、受众(API 开发者/终端用户/内部团队,影响措辞)、已知破坏性变更、上一版本行为(可选,用于准确写 Changed)、范围(整个产品/特定包或模块)。

输出格式:按 Keep a Changelog 组织,含版本与日期标题,以及 Breaking Changes ⚠️、Added、Changed、Fixed、Deprecated、Removed、Security 等小节;无内容的章节省略。破坏性变更置顶并附具体迁移操作。

写作规则:面向读者而非提交者;修复条目描述“坏了什么”而非实现;相关提交合并为一条;使用主动语态祈使语气(Add、Fix、Remove);不列内部微提交。

附带材料:references/user-translation.md 提供提交到变更日志的翻译校准;templates/release-entry.md 为可自行填写的模板。

质量评分:0–40 分,32 分以上为可交付,维度包括面向读者翻译、破坏性变更处理、筛选与分组、格式规范。

限制:需用户提供提交或说明等输入;不编造未提供的版本、日期或变更内容;不包含实现细节与内部标识符。