Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 2.02 KB

Evolution.md

File metadata and controls

31 lines (20 loc) · 2.02 KB

English Version

演进

SaltedFish Club 对所有明确声明未 ArchiveAPI / 库/程序 不断维护,目的是引入新的功能,改良 API 等。
维护者会严谨地推进每一项修改,并提供迁移周期。

在项目未进行文档描述更新策略变更的情况下,以此作为基准

语义化版本

我们使用 语义化版本 2.0 规范进行命名。

在开发中,Maintainer 以 -M1-M2 等后缀发布里程碑版本,此类版本标志一系列功能的完成,并且里程碑版本内可能会引入新的 API 变更,并不稳定。
在大版本即将发布前,Maintainer 会以 -RC 版本后缀发布最终的预览版本,表示新版本 API 已经确定,离稳定版发布只差最后的一些内部优化或 bug 修复。

更新兼容性

对于 x.y.z 版本号:

  • z 增加时,只会有 bug 修复和必要的代码添加,不会有破坏性更改。
  • y 增加时,总是会有 API 的变更(引入/废弃),废弃的 API 将会在两个次版本后删除,向下兼容保证。 对于较多破坏性更新的更改,Maintainer 总是会对 y 版本维护额外的时间,但是周期是正常 LTS 的六分之一。(两个月)
  • x 增加时,任何 API 都可能会变化,没有向下兼容保证。 每隔两个 x 发布一次 LTS ( Long Term Support ) 版本。
    • 对于 x 版本的 LTS 总是会基于 x 版本下最后一个 y.z 版本开发,这意味着 x 版本下的其他 y.z 总是没有稳定性保障。

关于弃用

被弃用的API总是被标记 @Deprecated 注解,开发者在运行/编译时会收到警告。
介于 API/运行库 总是会添加更多的功能和支持,因此我们在尽力保证顺利迁移的同时也会维护长期支持版本。
通常一个长期支持版本(LTS)的支持时间是一年,对于 y 版本的 "LTS" 则是一个月。LTS 版本不会有任何特性更新,仅修复 bug。