首页/开发/Git 与协作速查/变更日志规范(Keep a Changelog)

变更日志规范(Keep a Changelog)

给使用者看的版本化说明:按版本分组,用 Added/Changed/Fixed 等类型记录可感知变化,而不是流水账式提交罗列。

Git 与协作速查开发更新于 2026-10-12
面向对象使用者与集成方
结构版本号 + 类型分组(Added/Changed/Fixed 等)
与提交的区别提交是过程记录,变更是结果描述

CHANGELOG.md 片段

CHANGELOG.md 片段
## [2.4.0] - 2026-10-01
### Added
- SSO 登录与账号绑定
### Fixed
- 修复 502 重试计数溢出
### Changed
- 默认超时从 30s 调整为 10s
变更日志写「发生了什么变化」,与发布说明互补:一个看历史,一个看本次升级。

易错点

  • 直接抓取 git log 当变更日志,粒度与语言都不适合使用者阅读
  • 版本条目与标签不一致会让排查版本差异时对不上号

数据来源与参考

  • Keep a Changelog(keepachangelog.com)
  • Semantic Versioning 2.0.0(semver.org)
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌