CHANGELOG

这是一个用于集中存放多个项目变更记录（CHANGELOG）的公共仓库。

约定

• 每个项目一个目录，例如：SimpleLDB/、hosAgent/
• 每个版本一个文件，文件名建议：vX.Y.Z_YYYY-MM-DD.md
• 版本号与项目 Git tag 对齐（例如：v0.0.14）

说明：该仓库会被各项目以 Git submodule 的方式引入。

Changelog 文件格式规范

写法规范（用户视角）

• 只描述用户可见的变化，不描述内部实现细节
• 不暴露技术栈、架构设计、API 端点、文件路径
• 不描述安全机制的实现细节
• 不暴露数据库结构

模板

# 项目名 vX.Y.Z（YYYY-MM-DD）

## 新功能
- 新增功能点 1
- 新增功能点 2

## 改进
- 改进内容 1
- 改进内容 2

## 问题修复
- 修复问题 1
- 修复问题 2

规范说明

1. 文件命名

   • 格式：vX.Y.Z_YYYY-MM-DD.md
   • 版本号遵循语义化版本规范
   • 日期为版本发布日期

2. 章节结构

   • 新功能：新增的用户可见功能
   • 改进：现有功能的改进和优化
   • 问题修复：修复的问题

3. 编写建议

   • 使用清晰、简洁的语言描述变更
   • 重点突出用户可见的变更
   • 遵循中文技术文档写作规范
   • 保持版本间格式一致性

示例

参考 example 目录的示例文件：

• v0.0.1 - 标准 changelog 模板示例

版本划分建议

根据 commit 类型和影响范围进行版本划分：

• Major 版本（X.0.0）：不兼容的 API 变更、架构重构
• Minor 版本（0.X.0）：新增功能、向后兼容的 API 变更
• Patch 版本（0.0.X）：Bug 修复、小改进、文档更新

单个 commit 可独立为一个 patch 版本，相关联的多个 commit 可合并为一个版本。