如何优雅地写CHANGELOG
目录
changlog.com是一个面向开发者的新闻博客网站，跟进开源软件的发展，犹如其名。本篇博文的基础便是其意在推广的一种维护更新日志的格式1，积累于开源社区的优秀实例，值得借鉴。
实例
# 更新日志
该项目所有值得关注的更新均记录于此。
日志格式基于[Keep a Changelog](https://keepachangelog.com/en/1.0.0/)，
版本号遵守[语义化版本格式](https://semver.org/lang/zh-CN/)。
## [未发布]
### 新增
- 功能1
- 功能2
### [1.0.0] - 2020-06-29
### 新增
- 功能1 由[@张三](联系地址)贡献
- xxx
### 修复
- 缺陷1
- xxx
### 更改
- 变化1
- xxx
### 删除
- 功能1
- xxx
### 计划弃用
- 功能1
- xxx
### 安全
- 改进1
- xxx
## [0.3.0] - 2020-05-27
......
[未发布]：此处为与先前版本的diff链接
[1.0.0]：此处为与先前版本的diff链接
[0.3.0]：此处为与先前版本的diff链接
......
几点说明
- 适用于所在公司未明确规范更新日志格式的开发者。
- 变化应及时写入未发布版本之下，正式打版本时做以整理。
- 版本号推荐使用语义化版本格式。
- 日志文件的内容中英文皆可，新增/修复/更改/删除/计划弃用/安全 对应于 Added/Fixed/Changed/Removed/Deprecated/Security。
- 随时可以重构日志。
转载许可
本作品采用知识共享署名-非商业性使用-禁止演绎4.0国际许可协议进行许可，转载时请注明原文链接。
-
项目原地址：keepachanglog ↩︎