docs(policy): Add SDK support period policy

rechrtb · Jul 1, 2020 · 399e6b0 · 399e6b0
1 parent c8109d3
commit 399e6b0
Show file tree

Hide file tree

Showing 2 changed files with 110 additions and 0 deletions.
diff --git a/SUPPORT_POLICY_CN.md b/SUPPORT_POLICY_CN.md
@@ -0,0 +1,54 @@
+有关 ESP8266 RTOS SDK 的最新支持政策，详见 [支持期限政策](./SUPPORT_POLICY_CN.md)。
+支持期限政策
+=================
+
+* [English Version](./SUPPORT_POLICY_EN.md)
+
+ESP8266 RTOS SDK 的每个主要版本和次要版本（如 V3.0、V3.1 等）自其首次稳定版本发布之日起将维护 18 个月。
+
+维护意味着 ESP8266 RTOS SDK 团队将会对 GitHub 上的发布分支继续进行 bug 修复、安全修补等，并根据需求定期发布新的 bugfix 版本。
+
+在某一版本支持期限结束，停止更新维护 (EOL) 前，建议用户升级到较新的 ESP8266 RTOS SDK 版本。根据《支持期限政策》，我们将停止对 EOL 版本进行 bug 修复。
+
+《支持期限政策》不适用于预发布版本（包括 beta、preview、`-rc` 和 `-dev` 版本等）。有时，在发布的版本中存在被标记为 "Preview" 的特定功能，则该功能也不在支持期限内。
+
+长期支持版本
+------------
+
+有些发布版本（例如 ESP8266 RTOS SDK V3.1）属于长期支持 (LTS) 版本。LTS 版本将自其首次稳定版本发布之日起维护 30 个月（2.5 年）。
+
+关于长期维护版本，在 github 上面正式的`第１次`发布该版本 release 的时候，会在标题上额外标注 `(LTS)`，例如：
+
+```
+ESP8266 RTOS SDK Release v3.4 (LTS)
+```
+
+后续的维护版本不会再额外标注 `(LTS)`，例如：
+
+```
+ESP8266 RTOS SDK Release v3.4.1
+```
+
+示例
+-----
+
+ESP8266 RTOS SDK V3.1 于 2019 年 01 月发布，属于 LTS 版本，自正式发布日开始将维护 30 个月至 2021 年 07 月停止。
+
+- V3.1 的首个发布版本为 2019 年 01 月发布的 `v3.1`。
+- ESP8266 RTOS SDK 团队将持续进行 bug 修复、安全修补等更新，并 backport 至分支 `release/v3.1`。
+- 定期从 release 分支创建稳定的 bugfix 版本，比如，`v3.1.1`、`v3.1.2` 等，并建议用户保持使用最新的 bugfix 版本。
+- V3.1 的 bugfix 版本发布将持续 30 个月至 2021 年 07 月，届时所有 V3.1.x 将停止更新维护。
+
+现有版本
+--------
+
+ESP8266 RTOS SDK V3.3 及所有后续更新版本都将遵守该《支持期限政策》。每一版本发布时将同时公布其支持期限。
+
+对于该政策公布之日前发布的其他版本，应适用下述支持期限：
+
+- ESP8266 RTOS SDK V3.3.x 将维护至 2021 年 12 月。
+- ESP8266 RTOS SDK V3.2.x 将维护至 2020 年 12 月。
+- ESP8266 RTOS SDK V3.1.x 作为长期维护版本，将维护至 2021 年 7 月。
+- ESP8266 RTOS SDK V3.0.x 将维护至 2020 年 10 月。
+- ESP8266 RTOS SDK V2.1.x 作为长期维护版本，将维护至 2021 年 4 月。
+- ESP8266 RTOS SDK V2.0.x 及之前的版本均已停止更新维护 (EOL)。
diff --git a/SUPPORT_POLICY_EN.md b/SUPPORT_POLICY_EN.md
@@ -0,0 +1,56 @@
+The latest support policy for ESP8266 RTOS SDK can be found at [Support Policy](./SUPPORT_POLICY_EN.md).
+
+Support Period Policy
+=================
+
+* [中文版](./SUPPORT_POLICY_CN.md)
+
+Each ESP8266 RTOS SDK major and minor release (V3.0, V3.1, etc) is supported for 18 months after the initial stable release date.
+
+Supported means that the ESP8266 RTOS SDK team will continue to apply bug fixes, security fixes, etc to the release branch on GitHub, and periodically make new bugfix releases as needed.
+
+Users are encouraged to upgrade to a newer ESP8266 RTOS SDK release before the support period finishes and the release becomes End of Life (EOL). It is our policy to not continue fixing bugs in End of Life releases.
+
+Pre-release versions (betas, previews, -rc and -dev versions, etc) are not covered by any support period. Sometimes a particular feature is marked as "Preview" in a release, which means it is also not covered by the support period.
+
+
+Long Term Support releases
+------------
+
+Some releases (for example, ESP8266 RTOS SDK V3.1) are designated Long Term Support (LTS). LTS releases are supported for 30 months (2.5 years) after the initial stable release date.
+
+We will add a `(LTS)` tag when we release a long term support version on GitHub at the first time. For example:
+
+```
+ESP8266 RTOS SDK Release v3.4 (LTS)
+```
+
+But we will not add `(LTS)` tag to the following bug fix versions. For example:
+
+```
+ESP8266 RTOS SDK Release v3.4.1
+```
+
+Example
+-----
+
+ESP8266 RTOS SDK V3.1 was released in January 2019 and is a Long Term Support (LTS) release, meaning it will be supported for 30 months until July 2021.
+
+- The first V3.1 release was `v3.1` in January 2019.
+- The ESP8266 RTOS SDK team continues to backport bug fixes, security fixes, etc to the release branch `release/v3.1`。
+- Periodically stable bugfix releases are created from the release branch. For example `v3.1.1`、`v3.1.2`, etc. Users are encouraged to always update to the latest bugfix release.
+- V3.1 bugfix releases continue until July 2021, when all V3.1.x releases become End of Life.
+
+Existing Releases
+--------
+
+ESP8266 RTOS SDK V3.3 and all newer releases will follow this support period policy. The support period for each release will be announced when the release is made.
+
+For releases made before the support period policy was announced, the following support periods apply:
+
+- ESP8266 RTOS SDK V3.2.x will be supported until December 2021.
+- ESP8266 RTOS SDK V3.2.x will be supported until December 2020.
+- ESP8266 RTOS SDK V3.1.x is Long Term Support (LTS) release, will be supported until July 2021.
+- ESP8266 RTOS SDK V3.0.x will be supported until October 2020.
+- ESP8266 RTOS SDK V2.1.x is Long Term Support (LTS) release, will be supported until April 2021.
+- ESP8266 RTOS SDK V2.0.x and earlier versions are already End of Life.