Skip to content

Changelog Guidelines

CHANGELOG.md 采用 Keep a Changelog 风格,所有对外可见变更都应记录。

1. 记录范围

必须记录:

  • 新增能力(API、包、命令、示例)
  • 行为变化(默认值、流程、输出格式)
  • 修复问题(尤其是兼容性和安全相关)
  • 破坏性变更

可不记录:

  • 纯重构且行为不变、对用户无感知的内部实现细节

2. 分组建议

## [Unreleased] 下使用以下小节:

  • ### Added
  • ### Changed
  • ### Fixed
  • ### Removed
  • ### Security

3. 描述规范

  • 每条变更描述“做了什么 + 影响什么”
  • 尽量带上模块/包名,便于用户定位
  • 避免只写“优化了一些内容”

4. 发布流程中的处理

发布时通过 scripts/release.mjsUnreleased 变更沉淀到目标版本。 如果自动生成了 TBD 项,发布前必须手动补齐。

Released under the MIT License.