· Jeff · 教程
如何维护更新日志(CHANGELOG):写给下一任开发者的项目说明书
更新日志不是给机器看的 git log,是给「下一个打开你项目的人」看的说明书。这篇讲清 CHANGELOG 的六大原则、六种变动类型、一份可直接抄的模板,以及 Unreleased 工作流、该避开的坏做法,还有怎么和 Conventional Commits 配合把维护成本压到最低。
更新日志不是给机器看的 git log,是给「下一个打开你项目的人」看的说明书。这篇讲清 CHANGELOG 的六大原则、六种变动类型、一份可直接抄的模板,以及 Unreleased 工作流、该避开的坏做法,还有怎么和 Conventional Commits 配合把维护成本压到最低。
一份可直接照做的约定式提交规范:格式、类型、SemVer 对应、破坏性变更标记,附示例。