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
|
=============================
NEP 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>
:Resolution: <url> (required for Accepted | Rejected | Withdrawn)
Abstract
--------
The abstract should be a short description of what the NEP will achieve.
Detailed description
--------------------
This section describes the need for the NEP. It should describe the existing
problem that it is trying to solve and why this NEP makes the situation better.
It should include examples of how the new functionality would be used and
perhaps some use cases.
Implementation
--------------
This section lists the major steps required to implement the NEP. 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 development branches containing work on this NEP should
be linked to from here. (A NEP 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 NEP 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 NEP:
- This includes links to mailing list threads or relevant GitHub issues.
References and Footnotes
------------------------
.. [1] Each NEP must either be explicitly labeled as placed in the public domain (see
this NEP as an example) or licensed under the `Open Publication License`_.
.. _Open Publication License: https://www.opencontent.org/openpub/
Copyright
---------
This document has been placed in the public domain. [1]_
|
