为什么要写 CHANGELOG?
CHANGELOG(更新日志)是一个按时间倒序排列的列表,记录了项目中所有具有显著意义的变更。 它的读者是人类,而不是机器。 很多开发者错误地直接导出 Git Commit 记录,但这往往充斥着“fix bug”、“update”等对用户毫无意义的信息。
🚨 痛点 1:用户不知道新版本更新了什么
解决方案: 遵循 Keep a Changelog 规范。将变更分为六大类:Added(新功能)、Fixed(修复漏洞)、Changed(功能改进)等。 这样用户一眼就能看到他们关心的部分,例如:“Fixed: 解决了 iOS 下页面崩溃的问题”。 本工具通过可视化界面引导你完成这种分类,确保日志的高可读性。
🚨 痛点 2:版本号混乱,升级成本难以预估
解决方案: 配合 语义化版本 (SemVer) 。通过 CHANGELOG 明确告知用户:这是一个补丁版本(只有 Fixed)、次要版本(有 Added 但向前兼容)还是重大版本(有 Removed 或 Breaking Changes)。 清晰的日志能显著降低下游开发者的集成风险,提升项目的专业度和用户信任。
好的 CHANGELOG 应该具备什么?
- 易于阅读 :使用 Markdown 格式,层级分明。
- 按版本分组 :最新的版本始终排在最前面。
- 包含日期 :明确每个版本的发布时刻。
- 避免废话 :不要包含那些只对内部开发有意义的微小改动。
如何使用本工具?
- 点击“新版本”,输入版本号和日期。
- 选择变更类型(如 Fixed),输入描述内容,点击添加。
- 实时预览右侧生成的 Markdown。
-
点击“下载”,将其重命名为
CHANGELOG.md放入你的项目根目录。