关于代码开发中的 Changelog

因为我们在做一个项目的自动版本更新(让用户手动点击更新 SaaS 软件的版本),开发中混乱的版本管理和 Commit 注释,有时候让人抓狂。

这里有两个链接或许值得阅读:
https://keepachangelog.com/en/1.0.0/
https://co-pilot.dev/changelog#best-practices-release-dates-apply

  • Changelog 的正式文件名就叫 CHANGELOG.md
  • 必须是倒排序的
  • 用 ISO 格式(YYYY-MM-DD)来写日期,并和版本号一起写在每个 Change 的开头
  • 对不同的修改进行归类
  • 高亮重大的修改和功能废弃

这篇文章里有比较好的例子: https://depfu.com/blog/what-makes-a-good-changelog
另外可以参考 github 上 MD 写作指引: https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax

作者: 甬洁网络

--移动互联网&物联网技术提供商