1 说明

更新说明，GitHub 社区和开源项目中也普遍采用这种方式。

2 创建 CHANGELOG.md

在项目根目录下创建一个 CHANGELOG.md 文件，用于记录所有版本的更新信息。

3 推荐的格式

CHANGELOG.md 的格式可以参考以下模板：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# Changelog

## [Unreleased]
### Added
- 新增的功能或模块

### Changed
- 对现有功能的改进或变更

### Fixed
- 修复的 Bug 或问题

## [1.0.1] - 2024-11-08
### Added
- 添加了用户自定义的 `emptyStateText` 支持。

### Fixed
- 修复了 `SuggestModal` 无法显示自定义消息的问题。

## [1.0.0] - 2024-10-01
### Added
- 初始版本发布，包含核心功能。

4 版本说明规范

  • 版本号：每次更新都在新版本号下添加变更说明，遵循语义化版本规范（SemVer）（例如 1.0.1）。
  • 日期：在版本号旁注明发布日期，方便追溯。
  • 分类：将变更按类型分组（Added 新增、Changed 更改、Fixed 修复等），便于快速查找。
  • 排序：最新版本放在顶部，以便于快速阅读最新的更新内容。

这种方式可以帮助你在项目中清晰地记录版本更新历史，并保持 README 文件简洁。