diff --git a/docs/Dev/Spark-Store-Git-Repo.md b/docs/Dev/Spark-Store-Git-Repo.md index a9b5025a71e42fb222eb45b949fa72899587e7cc..3b8d471322d09427b546dca5b7cd8b502f685f6c 100644 --- a/docs/Dev/Spark-Store-Git-Repo.md +++ b/docs/Dev/Spark-Store-Git-Repo.md @@ -31,36 +31,49 @@ 在 Gitee 发布新的 Release 时有一个标题和一个标签,标题和标签均与版本号保持一致。 -此处写的版本号就是软件包的实际版本号,应遵循 [`Semantic Versioning`](https://semver.org/#semantic-versioning-specification-semver) 规则: +当版本号中出现`~`时,可以在标签中省略。如实际版本号为 `3.3.3~test3`,可以但仅可以在标签中写成 `3.3.3test3`。 -> Given a version number MAJOR.MINOR.PATCH, increment the: +此处写的版本号就是软件包的实际版本号,应遵循 [`语义化版本控制规范(SemVer)`](https://semver.org/lang/zh-CN/#%E8%AF%AD%E4%B9%89%E5%8C%96%E7%89%88%E6%9C%AC%E6%8E%A7%E5%88%B6%E8%A7%84%E8%8C%83semver) : + +> 版本格式:主版本号.次版本号.修订号,版本号递增规则如下: > -> 1. MAJOR version when you make incompatible API changes -> 2. MINOR version when you add functionality in a backwards compatible manner -> 3. PATCH version when you make backwards compatible bug fixes +> 1. 主版本号:当进行了较大的跨越性的改动; +> 2. 次版本号:当你做了向下兼容的功能性新增; +> 3. 修订号:当你做了向下兼容的问题修正。 > -> Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format. +> 先行版本号及版本编译信息可以加到“主版本号.次版本号.修订号”的后面,作为延伸。 + +例子:`3.1.4~test3` 主版本号是 `3`,次版本号是 `1`,修订号是 `4`,特殊版本号是`test3` + +意思是第三版第一个功能更新下第四个修复版本,正式发布前已经进行了三次修改,这是第三次测试 + +注意:`3.1.4~test3` 版本被认为低于 `3.1.4`。 -对于紧急发布的更新,应当按照规则增加版本号。 +所有使用特殊版本号的版本都低于无特殊版本号的对应版本。 -对于预览版,应当按照规则增加后缀。 +对于紧急发布的更新,也应当按照规则增加版本号。 任意两个有区别的版本均不可以共用一个版本号,不论发布时间相距多么近。 ### 更新日志规则 -更新日志应始终使用列表格式,有以下 5 种消息类型: +更新日志应始终使用列表格式,有以下 10 种消息类型: -* `新增`:本次更新中新增的功能、内容,消息内容可以描述新增的功能是什么,但请不要重复`新增`这个词 -* `修复`:本次更新中解决的问题,可以使用`解决了 XX 问题`的句式 -* `调整`:本次更新中作出的一般性变更 -* `回滚`:本次更新中作出的回退性变更 -* `说明`:用来写与更新内容无关的话,比如『该版本为测试版,普通用户请安装最新的正式版』 +* `新增`:本次更新中新增的功能、内容,消息内容可以描述新增的功能是什么,但请不要重复`新增`这个词; +* `修正`:本次更新中解决的问题,可以使用`解决了 XX 问题`的句式; +* `文档`:本次更新中对项目文档的变动(一般不需要在 Release 中写出); +* `格式`:不影响代码运行的变动(一般不需要在 Release 中写出); +* `重构`:影响代码运行,但既没有新增功能也没有修复问题的变动(一般不需要在 Release 中写出); +* `性能`:提升性能的变动; +* `构建`:依赖的外部资源、构建工具或辅助工具的变动; +* `调整`:本次更新中作出的一般性变更; +* `回滚`:本次更新中作出的回退性变更; +* `说明`:用来写与更新内容无关的话,比如『该版本为测试版,普通用户请安装最新的正式版』; 更新日志的每一项均应以消息类型开头,后跟全角冒号,按照上面列出的顺序书写,例如: > * 新增:支持应用详情页显示升级/重新安装; -> * 修复:解决应用详情页经常加载失败的问题; +> * 修正:解决应用详情页经常加载失败的问题; > * 调整:尝试开启 Hidpi 支持; > * 回滚:更新中行为到进度条而不是实时输出; > * 说明:DTK 界面版本后续随缘维护更新。