changie 提供了比较友好的changelogs 说明
changelog 的一些原则
- 记住日志是写给人而非机器的
- 每个版本都应该有独立的入口
- 同类改动应该分组放置
- 不同版本应分别设置链接
- 新版本在前，旧版本在后
- 应包括每个版本的发布日期
- 注明是否遵守语义化版本规范
changie 提供的一些changes 类型
- Added 新特性的
- Changed 修改存在的函数
- Deprecated 废弃，未来可能会移除的
- Removed 移除的一些特性
- Fixed bug 修复
- Security 安全问题
说明
changie 是一个很不错的changelogs 工具，实际上不支持可以和git 集成，我们进行文档处理也是可以的, 同时changie 也是支持对于格式以及类型的自定义的，后边简单说明下使用
参考资料
https://changie.dev/
https://github.com/miniscruff/changie
https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md
https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html#Style-of-Change-Logs