用途:维护项目根目录的 CHANGELOG.md,按 Keep a Changelog(1.1.0)格式记录显著变更,配合语义化版本。适用于实现新功能、修复缺陷或做出其他值得记录的改动之后。
主要能力:按固定顺序使用 Added、Changed、Deprecated、Removed、Fixed、Security 六类;无变更说明时读取 git diff 或近期提交来识别和归类改动;在 [Unreleased] 段落追加条目,必要时创建类别小节;发布版本时把 [Unreleased] 内容移入新版本小节并更新底部比较链接;文件不存在时按标准头部创建 CHANGELOG.md。
使用方式:指定变更内容或直接让其检查 git diff;条目写在 [Unreleased] 下,使用短横线项目符号,每行一条;描述面向用户,说明影响而非实现细节,例如用“登录在密码重置后失败的问题已修复”而非“修复 bug”;相关改动可分组为带子项的列表。
限制:仅为未验证的改动添加条目会违反其防幻觉规则,不添加未实际发生的变更、不猜测改动作用、不重复条目、除非存在用户影响否则不记录内部重构;不隐藏破坏性变更或安全问题;缺失的价格、平台、安装命令等信息暂未提供。