1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
.. _skip_template:
==================================
SKIP X — Template and Instructions
==================================
:Author: <list of authors' real names and, optionally, email addresses>
:Status: <Draft | Active | Accepted | Deferred | Rejected | Withdrawn |
Final | Superseded>
:Type: <Standards Track | Process>
:Created: <date created on, in yyyy-mm-dd format>
:Resolved: <date resolved, in yyyy-mm-dd format>
:Resolution: <url> (required for Accepted | Rejected | Withdrawn)
:Version effective: <version-number> (for accepted SKIPs)
Abstract
--------
The abstract should be a short description of what the SKIP will achieve.
Motivation and Scope
--------------------
This section describes the need for the proposed change. It should describe the
existing problem, who it affects, what it is trying to solve, and why. This
section should explicitly address the scope of and key requirements for the
proposed change.
Detailed description
--------------------
This section should provide a detailed description of the proposed change. It
should include examples of how the new functionality would be used, intended
use-cases, and pseudocode illustrating its use.
Related Work
------------
This section should list relevant and/or similar technologies, possibly in
other libraries. It does not need to be comprehensive, just list the major
examples of prior and relevant art.
Implementation
--------------
This section lists the major steps required to implement the SKIP. Where
possible, it should be noted where one step is dependent on another, and which
steps may be optionally omitted. Where it makes sense, each step should
include a link related pull requests as the implementation progresses.
Any pull requests or developmt branches containing work on this SKIP should
be linked to from here. (A SKIP does not need to be implemented in a single
pull request if it makes sense to implement it in discrete phases).
Backward compatibility
----------------------
This section describes the ways in which the SKIP breaks backward
compatibility.
Alternatives
------------
If there were any alternative solutions to solving the same problem, they
should be discussed here, along with a justification for the chosen
approach.
Discussion
----------
This section may just be a bullet list including links to any discussions
regarding the SKIP, but could also contain additional comments about that
discussion:
- This includes links to discussion forum threads or relevant GitHub discussions.
References and Footnotes
------------------------
All SKIPs should be declared as dedicated to the public domain with the CC0
license [1]_, as in `Copyright`, below, with attribution encouraged with CC0+BY
[2]_.
.. [1] CC0 1.0 Universal (CC0 1.0) Public Domain Dedication,
https://creativecommons.org/publicdomain/zero/1.0/
.. [2] https://dancohen.org/2013/11/26/cc0-by/
Copyright
---------
This document is dedicated to the public domain with the Creative Commons CC0
license [1]_. Attribution to this source is encouraged where appropriate, as per
CC0+BY [2]_.
|
