|
1 | | -# 变更日志 |
| 1 | +# 变更日志 (CHANGELOG) |
2 | 2 |
|
3 | | -> 记录 monSQLize 的重大变更历史,便于追踪演进过程 |
4 | | -> 详细变更内容请查看 `changelogs/` 目录下的对应文档 |
| 3 | +> **说明**: 版本摘要,详细需求见 [STATUS.md](STATUS.md) |
| 4 | +> **最后更新**: 2025-12-12 |
| 5 | +> **文档版本**: 2.0(符合 AI 开发规范 v4.6) |
5 | 6 |
|
6 | 7 | --- |
7 | 8 |
|
8 | 9 | ## 版本概览 |
9 | 10 |
|
10 | | -| 版本 | 日期 | 变更摘要 | 详细文档 | |
11 | | -|------|------|---------|------------------------------| |
12 | | -| v1.2.0 | 2025-12-12 | TypeScript增强 + 安全加固 + 工具链现代化 | [详细](changelogs/v1.2.0.md) | |
13 | | -| v1.1.0 | 2025-12-03 | 新增 Change Streams 实时监听功能(watch方法) | [详细](changelogs/v1.1.0.md) | |
14 | | -| v1.0.0 | 2025-12-03 | 正式发布,生产就绪,已发布到 npm | [详细](changelogs/v1.0.0.md) | |
15 | | -| v0.3.0 | 2025-12-02 | 新增完整的 Admin/Management 功能(18个方法) | [详细](changelogs/v0.3.0.md) | |
| 11 | +| 版本 | 日期 | 变更摘要 | 详细 | |
| 12 | +|------|------|---------|------| |
| 13 | +| [v1.2.0](STATUS.md#v120) | 2025-12-15 | TypeScript增强 + 安全加固 + 工具链现代化 | [查看](STATUS.md#v120) | |
| 14 | +| [v1.1.0](STATUS.md#v110) | 2025-12-03 | 新增 Change Streams 实时监听功能(watch方法) | [查看](STATUS.md#v110) | |
| 15 | +| [v1.0.0](STATUS.md#v100) | 2025-12-03 | 正式发布,生产就绪,已发布到 npm | [查看](STATUS.md#v100) | |
| 16 | +| [v0.3.0](STATUS.md#v030) | 2025-12-02 | 新增完整的 Admin/Management 功能(18个方法) | [查看](STATUS.md#v030) | |
16 | 17 |
|
17 | 18 | --- |
18 | 19 |
|
|
21 | 22 | | 版本系列 | 版本数 | 主要改进方向 | |
22 | 23 | |---------|-------|------------| |
23 | 24 | | v1.x | 3 | 核心功能完善、生产发布、实时监听、TypeScript增强 | |
24 | | -| v0.x | 1+ | 基础功能开发、管理功能 | |
| 25 | +| v0.x | 1 | 基础功能开发、管理功能 | |
| 26 | + |
| 27 | +--- |
| 28 | + |
| 29 | +## 维护说明 |
| 30 | + |
| 31 | +### 添加新版本的步骤 |
| 32 | + |
| 33 | +1. **创建需求文档**(如需要) |
| 34 | + ```bash |
| 35 | + cp plans/TEMPLATE.md plans/req-your-feature.md |
| 36 | + # 填充需求详细信息 |
| 37 | + ``` |
| 38 | + |
| 39 | +2. **更新 STATUS.md** |
| 40 | + - 在"发布计划"表格添加新版本行 |
| 41 | + - 添加版本章节(### vX.Y.Z) |
| 42 | + - 在版本表格添加需求行 |
| 43 | + - 链接到 plans/ 文档(如有) |
| 44 | + |
| 45 | +3. **更新 CHANGELOG.md** |
| 46 | + - 在"版本概览"表格最上方添加新行 |
| 47 | + - 格式:`| [vX.Y.Z](STATUS.md#vxyz) | 日期 | 摘要 | [查看](STATUS.md#vxyz) |` |
| 48 | + |
| 49 | +4. **提交变更** |
| 50 | + ```bash |
| 51 | + git add STATUS.md CHANGELOG.md plans/ |
| 52 | + git commit -m "docs: 发布 vX.Y.Z" |
| 53 | + ``` |
| 54 | + |
| 55 | +### 版本号规则 |
| 56 | + |
| 57 | +遵循[语义化版本](https://semver.org/lang/zh-CN/)(Semantic Versioning): |
| 58 | + |
| 59 | +- **MAJOR** (x.0.0) - 不兼容的 API 变更 |
| 60 | +- **MINOR** (0.x.0) - 向后兼容的新增功能 |
| 61 | +- **PATCH** (0.0.x) - 向后兼容的问题修复 |
| 62 | + |
| 63 | +示例: |
| 64 | +- `1.0.0 → 1.0.1` - Bug 修复 |
| 65 | +- `1.0.0 → 1.1.0` - 新功能 |
| 66 | +- `1.0.0 → 2.0.0` - 破坏性变更 |
25 | 67 |
|
26 | 68 | --- |
27 | 69 |
|
28 | 70 | ## 快速导航 |
29 | 71 |
|
30 | 72 | ### 按功能类型查找 |
31 | | -- **TypeScript增强**: v1.2.0 |
32 | | -- **安全加固**: v1.2.0 |
33 | | -- **工具链现代化**: v1.2.0 |
34 | | -- **实时监听**: v1.1.0 |
35 | | -- **生产发布**: v1.0.0 |
36 | | -- **管理功能**: v0.3.0 |
| 73 | + |
| 74 | +- **TypeScript增强**: [v1.2.0](STATUS.md#v120) |
| 75 | +- **安全加固**: [v1.2.0](STATUS.md#v120) |
| 76 | +- **工具链现代化**: [v1.2.0](STATUS.md#v120) |
| 77 | +- **实时监听**: [v1.1.0](STATUS.md#v110) |
| 78 | +- **生产发布**: [v1.0.0](STATUS.md#v100) |
| 79 | +- **管理功能**: [v0.3.0](STATUS.md#v030) |
37 | 80 |
|
38 | 81 | ### 按变更类型查找 |
| 82 | + |
| 83 | +- **新功能**: v1.1.0, v1.0.0, v0.3.0 |
39 | 84 | - **类型定义**: v1.2.0 |
40 | 85 | - **安全**: v1.2.0 |
41 | 86 | - **工具链**: v1.2.0 |
42 | | -- **新功能**: v1.1.0, v1.0.0, v0.3.0 |
43 | 87 | - **性能优化**: v1.0.0 |
44 | 88 | - **Bug修复**: v0.3.0, v1.2.0 |
45 | 89 |
|
|
48 | 92 | ## 里程碑版本 |
49 | 93 |
|
50 | 94 | ### v1.0.0 - 正式发布 🎉 |
| 95 | + |
| 96 | +**发布日期**: 2025-12-03 |
| 97 | +**重要性**: ⭐⭐⭐⭐⭐ |
| 98 | + |
| 99 | +**核心成就**: |
51 | 100 | - ✅ 已发布到 npm |
52 | 101 | - ✅ 生产就绪 |
53 | 102 | - ✅ 企业级质量(96/100 A+) |
54 | 103 | - ✅ 1000+ 测试用例 |
55 | 104 | - ✅ 77%+ 测试覆盖率 |
56 | 105 |
|
| 106 | +**详细信息**: [查看 STATUS.md](STATUS.md#v100) |
| 107 | + |
57 | 108 | --- |
58 | 109 |
|
59 | | -## 变更文档结构 |
| 110 | +## 详细变更文档 |
60 | 111 |
|
61 | | -详细变更文档位于 `changelogs/` 目录: |
| 112 | +> **说明**: 详细变更文档位于 `changelogs/` 目录(历史版本,保留供参考) |
62 | 113 |
|
63 | 114 | ``` |
64 | 115 | changelogs/ |
65 | 116 | ├── TEMPLATE.md # 变更文档模板 |
| 117 | +├── v1.2.0.md # v1.2.0 详细变更 |
66 | 118 | ├── v1.1.0.md # v1.1.0 详细变更 |
67 | 119 | ├── v1.0.0.md # v1.0.0 详细变更 |
68 | 120 | └── v0.3.0.md # v0.3.0 详细变更 |
69 | 121 | ``` |
70 | 122 |
|
71 | | -每个详细变更文档包含: |
72 | | -- ✅ 版本信息、变更分类 |
73 | | -- ✅ 背景说明、详细内容 |
74 | | -- ✅ 影响范围、验证方法 |
75 | | -- ✅ 使用示例、相关资源 |
76 | | -- ✅ 设计决策、未来改进 |
77 | | - |
78 | | ---- |
79 | | - |
80 | | -## 版本规范 |
81 | | - |
82 | | -遵循[语义化版本](https://semver.org/lang/zh-CN/)(Semantic Versioning): |
83 | | - |
84 | | -- **MAJOR** (x.0.0) - 不兼容的 API 变更 |
85 | | -- **MINOR** (0.x.0) - 向后兼容的新增功能 |
86 | | -- **PATCH** (0.0.x) - 向后兼容的问题修复 |
87 | | - |
88 | | -示例: |
89 | | -- `1.0.0 → 1.0.1` - Bug 修复 |
90 | | -- `1.0.0 → 1.1.0` - 新功能 |
91 | | -- `1.0.0 → 2.0.0` - 破坏性变更 |
92 | | - |
93 | | ---- |
94 | | - |
95 | | -## 贡献指南 |
96 | | - |
97 | | -### 如何记录变更 |
98 | | - |
99 | | -1. 创建详细变更文档 |
100 | | - - 使用 `changelogs/TEMPLATE.md` 作为模板 |
101 | | - - 文件命名:`changelogs/vX.Y.Z.md` |
102 | | - - 填写完整的变更信息 |
103 | | - |
104 | | -2. 更新主 CHANGELOG |
105 | | - - 在"版本概览"表格最上方添加新行 |
106 | | - - 格式:`| 版本 | 日期 | 变更摘要 | [详细](changelogs/vX.Y.Z.md) |` |
107 | | - |
108 | | -3. 提交变更 |
109 | | - ```bash |
110 | | - git add CHANGELOG.md changelogs/vX.Y.Z.md |
111 | | - git commit -m "docs: 发布 vX.Y.Z" |
112 | | - ``` |
| 123 | +**注意**: |
| 124 | +- changelogs/ 目录包含历史详细变更文档 |
| 125 | +- 新版本应优先使用 plans/ 目录存储需求文档 |
| 126 | +- changelogs/ 文档仅供参考,不再更新 |
113 | 127 |
|
114 | 128 | --- |
115 | 129 |
|
116 | | -## 历史版本查询 |
| 130 | +## 相关文档 |
117 | 131 |
|
118 | | -- **最新版本**: v1.1.0 |
119 | | -- **稳定版本**: v1.0.0 |
120 | | -- **开发版本**: 查看 [GitHub Releases](https://github.com/yourusername/monSQLize/releases) |
| 132 | +- [STATUS.md](./STATUS.md) - 需求状态追踪 |
| 133 | +- [plans/](./plans/README.md) - 需求详细文档 |
| 134 | +- [README.md](./README.md) - 项目说明 |
| 135 | +- [changelogs/](./changelogs/README.md) - 历史详细变更(供参考) |
121 | 136 |
|
122 | 137 | --- |
123 | 138 |
|
124 | | -**文档版本**: 1.0 |
125 | | -**最后更新**: 2025-12-10 |
126 | | -**格式标准**: AI 开发规范 v4.2 - 通用项目 CHANGELOG 格式 |
| 139 | +**文档版本**: 2.0 |
| 140 | +**最后更新**: 2025-12-12 |
| 141 | +**格式标准**: AI 开发规范 v4.6 § 3.3 |
127 | 142 |
|
0 commit comments