From 99b3560b88cffb719860c8c7ea4fea490b8b099c Mon Sep 17 00:00:00 2001 From: csh Date: Fri, 12 Dec 2025 17:53:16 +0800 Subject: [PATCH] =?UTF-8?q?:remove:=20remove(=E8=A7=84=E8=8C=83)=EF=BC=9A?= =?UTF-8?q?=E5=88=A0=E9=99=A4=E7=89=88=E6=9C=AC=E8=A7=84=E8=8C=83=E7=AD=89?= =?UTF-8?q?=EF=BC=8C=E5=90=8E=E7=BB=AD=E9=87=87=E7=94=A8=20[=E6=96=B0?= =?UTF-8?q?=E8=A7=84=E8=8C=83](https://git.mytsl.cn/csh/tsl-playbook.git)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONVENTIONS.md | 69 -------------------------------------------------- README.md | 14 ---------- 2 files changed, 83 deletions(-) delete mode 100644 CONVENTIONS.md diff --git a/CONVENTIONS.md b/CONVENTIONS.md deleted file mode 100644 index 2f9cc14..0000000 --- a/CONVENTIONS.md +++ /dev/null @@ -1,69 +0,0 @@ -# 模板说明 - -## :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` 版本可以随时破坏兼容性 - ---- diff --git a/README.md b/README.md index 024c4e2..b6763aa 100644 --- a/README.md +++ b/README.md @@ -46,17 +46,3 @@ 👉 **实用的 Actions 工作流，可直接复制使用** --- - -### 📝 [Conventions](./CONVENTIONS.md) - -**文档编写规范和版本命名规则** - -包含内容： - -- 📊 Emoji 图标使用规范 -- 🔢 版本号命名规则（SemVer） -- 📝 [CHANGELOG](./CHANGELOG.md) 模板 - -👉 **维护项目文档的统一规范，贡献者必读** - ----