|
1 | | -MEP Template |
2 | | -============ |
| 1 | +============== |
| 2 | + MEP Template |
| 3 | +============== |
| 4 | + |
| 5 | +.. contents:: |
| 6 | + :local: |
3 | 7 |
|
4 | 8 |
|
5 | | -This MEP template is a guideline of the sections that a MEP should contain. Extra sections may be added if appropriate, and unnecessary sections may be noted as such. |
| 9 | +This MEP template is a guideline of the sections that a MEP should |
| 10 | +contain. Extra sections may be added if appropriate, and unnecessary |
| 11 | +sections may be noted as such. |
6 | 12 |
|
7 | 13 | Status |
8 | | ------- |
| 14 | +====== |
9 | 15 |
|
10 | 16 | MEPs go through a number of phases in their lifetime: |
11 | 17 |
|
12 | | -- **Discussion**: The MEP is being actively discussed on the mailing list and it is being improved by its author. The mailing list discussion of the MEP should include the MEP number (MEPxxx) in the subject line so they can be easily related to the MEP. |
| 18 | +- **Discussion**: The MEP is being actively discussed on the mailing |
| 19 | + list and it is being improved by its author. The mailing list |
| 20 | + discussion of the MEP should include the MEP number (MEPxxx) in the |
| 21 | + subject line so they can be easily related to the MEP. |
13 | 22 |
|
14 | | -- **Progress**: Consensus was reached on the mailing list and implementation work has begun. |
| 23 | +- **Progress**: Consensus was reached on the mailing list and |
| 24 | + implementation work has begun. |
15 | 25 |
|
16 | 26 | - **Completed**: The implementation has been merged into master. |
17 | 27 |
|
18 | | -- **Superseded**: This MEP has been abandoned in favor of another approach. |
| 28 | +- **Superseded**: This MEP has been abandoned in favor of another |
| 29 | + approach. |
19 | 30 |
|
20 | 31 | Branches and Pull requests |
21 | | --------------------------- |
| 32 | +========================== |
22 | 33 |
|
23 | 34 | All development branches containing work on this MEP should be linked to from here. |
24 | 35 |
|
25 | | -All pull requests submitted relating to this MEP should be linked to from here. (A MEP does not need to be implemented in a single pull request if it makes sense to implement it in discrete phases). |
| 36 | +All pull requests submitted relating to this MEP should be linked to |
| 37 | +from here. (A MEP does not need to be implemented in a single pull |
| 38 | +request if it makes sense to implement it in discrete phases). |
26 | 39 |
|
27 | 40 | Abstract |
28 | | --------- |
| 41 | +======== |
29 | 42 |
|
30 | 43 | The abstract should be a short description of what the MEP will achieve. |
31 | 44 |
|
32 | 45 | Detailed description |
33 | | --------------------- |
| 46 | +==================== |
34 | 47 |
|
35 | | -This section describes the need for the MEP. It should describe the existing problem that it is trying to solve and why this MEP makes the situation better. It should include examples of how the new functionality would be used and perhaps some use cases. |
| 48 | +This section describes the need for the MEP. It should describe the |
| 49 | +existing problem that it is trying to solve and why this MEP makes the |
| 50 | +situation better. It should include examples of how the new |
| 51 | +functionality would be used and perhaps some use cases. |
36 | 52 |
|
37 | 53 | Implementation |
38 | | --------------- |
| 54 | +============== |
39 | 55 |
|
40 | | -This section lists the major steps required to implement the MEP. 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. |
| 56 | +This section lists the major steps required to implement the MEP. |
| 57 | +Where possible, it should be noted where one step is dependent on |
| 58 | +another, and which steps may be optionally omitted. Where it makes |
| 59 | +sense, each step should include a link related pull requests as the |
| 60 | +implementation progresses. |
41 | 61 |
|
42 | 62 | Backward compatibility |
43 | | ----------------------- |
| 63 | +====================== |
44 | 64 |
|
45 | 65 | This section describes the ways in which the MEP breaks backward incompatibility. |
46 | 66 |
|
47 | 67 | Alternatives |
48 | | ------------- |
| 68 | +============ |
49 | 69 |
|
50 | | -If there were any alternative solutions to solving the same problem, they should be discussed here, along with a justification for the chosen approach. |
| 70 | +If there were any alternative solutions to solving the same problem, |
| 71 | +they should be discussed here, along with a justification for the |
| 72 | +chosen approach. |
0 commit comments