SuperAPI AI 工具集

changelog

写作与研究

查看项目

更新于 10-16 02:35

技能介绍

用途:在编写或更新 CHANGELOG.md 文件时提供规范指引,使变更日志遵循 Keep a Changelog 格式,并与语义化版本(Semantic Versioning)配合使用。

主要能力:规定变更日志的标准结构,包括标题、格式说明、未发布(Unreleased)区块,以及按版本号与日期记录的条目。定义必须使用的变更类型:Added(新增功能、接口、选项)、Changed(现有功能变更)、Deprecated(计划移除)、Removed(已删除)、Fixed(缺陷修复)、Security(安全补丁)。提供决策树帮助判断某条变更应归入哪一类型,并给出好条目与坏条目的对照示例。

使用方式:在编写或更新 CHANGELOG.md 时套用该规则。基本结构为:先写 # Changelog 标题与 Keep a Changelog、语义化版本说明,再列出 [Unreleased] 区块,其中按 ### Added、### Changed、### Fixed 等小标题组织条目;已发布版本以 [1.2.0] - 2024-01-15 形式记录。

最佳实践:每次 PR 时更新变更日志;从用户视角描述变更;附上 issue/PR 编号;日期使用 ISO 格式(YYYY-MM-DD);未发布变更保留在顶部。

适用场景:需要长期维护版本发布记录、希望统一团队变更描述规范的软件项目。

限制:资料未说明具体安装命令、依赖平台、收费方式或自动化工具集成细节,这些方面暂未提供。