跳过X模板和说明¶
- 作者
<作者真实姓名列表,也可以选择电子邮件地址>
- 状态
<草稿|活动|已接受|已推迟|已拒绝|已撤回|最终|已被取代>
- 类型
<标准跟踪|流程>
- 已创建
<创建日期,yyyy-mm-dd格式>
- 已解决
<解析日期,yyyy-mm-dd格式>
- 分辨率
<url>(接受|拒绝|撤回需要)
- 版本生效
<Version-Number>(用于接受的跳过)
摘要¶
摘要应该是对跳跃将达到的效果的简短描述。
动机和范围¶
本节介绍拟议更改的必要性。它应该描述现有的问题,它影响到谁,它试图解决什么,以及为什么。本节应明确说明拟议更改的范围和关键要求。
详细说明¶
本节应提供拟议更改的详细说明。它应该包括如何使用新功能的示例、预期用例和说明其用法的伪代码。
实施¶
本节列出了实施跳过所需的主要步骤。在可能的情况下,应注意一个步骤依赖于另一个步骤的情况,以及哪些步骤可以随意省略。在有意义的地方,随着实现的进展,每个步骤都应该包括一个与Pull请求相关的链接。
任何拉请求或开发分支包含此跳过的工作,应该从这里链接到。(如果在离散阶段中实现跳过是有意义的,则不需要在单个Pull请求中实现它)。
向后兼容性¶
本节介绍跳过破坏向后兼容性的方式。
替代方案¶
如果有任何解决相同问题的替代解决方案,则应在此处讨论这些解决方案,并说明所选方法的合理性。
讨论¶
此部分可能只是一个项目符号列表,其中包含指向有关跳过的任何讨论的链接,但也可能包含有关该讨论的其他评论:
这包括指向邮件列表主题或相关GitHub问题的链接。
参考文献和脚注¶
所有跳过应声明为具有CC0许可证的公共领域专用 1, 如中所示 Copyright ,下面,由CC0+鼓励归因 2.
- 1(1,2)
CC01.0通用(CC01.0)公共域专用,https://creativecommons.org/publicdomain/zero/1.0/
- 2(1,2)