70 lines
2.1 KiB
Markdown
70 lines
2.1 KiB
Markdown
# 模板说明
|
||
|
||
## :label: 图例说明
|
||
|
||
| 图标 | 代码 | 说明 | 图标 | 代码 | 说明 |
|
||
| :-----------: | :-------------- | :------- | :-------------------: | :---------------------- | :------------ |
|
||
| :tada: | `:tada:` | 首次发布 | :sparkles: | `:sparkles:` | 新功能 |
|
||
| :bug: | `:bug:` | Bug 修复 | :rocket: | `:rocket:` | 性能优化 |
|
||
| :art: | `:art:` | 代码样式 | :recycle: | `:recycle:` | 代码重构 |
|
||
| :package: | `:package:` | 依赖更新 | :lock: | `:lock:` | 安全修复 |
|
||
| :warning: | `:warning:` | 废弃警告 | :wrench: | `:wrench:` | 配置变更 |
|
||
| :wastebasket: | `:wastebasket:` | 删除功能 | :busts_in_silhouette: | `:busts_in_silhouette:` | 贡献者 |
|
||
| :memo: | `:memo:` | 文档更新 | :bookmark: | `:bookmark:` | 发行/版本标签 |
|
||
|
||
---
|
||
|
||
## :pushpin: 版本号规范
|
||
|
||
### SemVer - 语义版本号
|
||
|
||
#### 格式
|
||
|
||
```txt
|
||
MAJOR.MINOR.PATCH
|
||
```
|
||
|
||
#### 字段说明
|
||
|
||
| 字段 | 说明 | 何时递增 |
|
||
| --------- | -------- | ------------------ |
|
||
| **MAJOR** | 主版本号 | 不兼容的 API 修改 |
|
||
| **MINOR** | 次版本号 | 向后兼容的功能新增 |
|
||
| **PATCH** | 修订号 | 向后兼容的问题修正 |
|
||
|
||
#### 更新规则
|
||
|
||
- **MAJOR（主版本）**：破坏性变更，不向后兼容。递增后 MINOR 和 PATCH 重置为 0
|
||
- **MINOR（次版本）**：新增功能但保持兼容。递增后 PATCH 重置为 0
|
||
- **PATCH（修订）**：仅修复 bug，不新增功能
|
||
|
||
#### 示例
|
||
|
||
```txt
|
||
1.0.0 # 首个稳定版
|
||
1.1.0 # 新增功能
|
||
1.1.1 # Bug 修复
|
||
2.0.0 # 破坏性变更
|
||
```
|
||
|
||
#### Pre-release 版本
|
||
|
||
```txt
|
||
1.0.0-alpha.1
|
||
1.0.0-beta
|
||
1.0.0-rc.1
|
||
1.0.0
|
||
```
|
||
|
||
#### 初始开发阶段
|
||
|
||
```txt
|
||
0.1.0 # 初始版本
|
||
0.2.0 # API 未稳定
|
||
1.0.0 # 首个稳定版 ✅
|
||
```
|
||
|
||
**注意**：`0.x.x` 版本可以随时破坏兼容性
|
||
|
||
---
|