更新日志是什么？

更新日志（Change Log）是一个由人工编辑，以时间为倒序的列表， 以记录一个项目中所有版本的显著变动。

为何要提供更新日志？

为了让用户和开发人员更简单明确的知晓项目在不同版本之间有哪些显著变动。

哪些人需要更新日志？

人人需要更新日志。无论是消费者还是开发者，软件的最终用户都关心软件所包含什么。 当软件有所变动时，大家希望知道改动是为何、以及如何进行的。

怎样制作高质量的更新日志？

指导原则

  • 记住日志是写给人的，而非机器。
  • 每个版本都应该有独立的入口。
  • 同类改动应该分组放置。
  • 版本与章节应该相互对应。
  • 新版本在前，旧版本在后。
  • 应包括每个版本的发布日期。

  • 注明是否遵守语义化版本格式.

    变动类型

  • Added 新添加的功能。

  • Changed 对现有功能的变更。
  • Deprecated 已经不建议使用，准备很快移除的功能。
  • Removed 已经移除的功能。
  • Fixed 对bug的修复
  • Security 对安全的改进