弃用条款
弃用
- 在结束对某个功能的支持或移除某个功能之前是必须的。
- 不推荐使用该功能。
- 开发仅限于优先级 1 / 严重性 1 的错误修复。
- 将在未来的主要版本中移除。
- 在宣布弃用并概述支持终止或移除日期后开始。
- 在支持终止日期或移除日期过后结束。
支持终止
- 移除前的可选步骤。
- 强烈不建议使用该功能。
- 不提供支持或修复。
- 内部不再进行测试。
- 将在未来的主要版本中移除。
- 在支持终止日期过后开始。
宣布支持终止期仅应在特殊情况下使用,不建议一般使用。大多数功能应先弃用,然后移除。
移除
- 功能使用不可能。
- 功能不再支持(如果尚未宣布支持终止期)。
- 发生在符合我们的 语义版本控制政策 的主要版本中。
- 在移除日期过后开始。
重大变更
“重大变更” 是指需要用户对其代码、设置或工作流程进行相应更改的任何更改。 “用户” 可能是人类、API 客户端,甚至是 “使用” 另一个类的代码类。重大变更的示例如下:
- 移除没有替代/解决方法的用户功能。
- 更改现有 API 的定义(通过重命名查询参数或更改路由等方式)。
- 从代码类中移除公共方法。
如果重大变更影响许多用户,或代表行为的显著变化,则可以被视为重大。