Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Massive MEP move #4293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 23 commits into from
Mar 30, 2015
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
DOC : clean up template
  • Loading branch information
tacaswell committed Mar 29, 2015
commit 1e07323cbb57c8c33819b605d1891054246be7d8
56 changes: 39 additions & 17 deletions 56 doc/devel/MEP/template.rst
Original file line number Diff line number Diff line change
@@ -1,50 +1,72 @@
MEP Template
============
==============
MEP Template
==============

.. contents::
:local:


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.
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.

Status
------
======

MEPs go through a number of phases in their lifetime:

- **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.
- **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.

- **Progress**: Consensus was reached on the mailing list and implementation work has begun.
- **Progress**: Consensus was reached on the mailing list and
implementation work has begun.

- **Completed**: The implementation has been merged into master.

- **Superseded**: This MEP has been abandoned in favor of another approach.
- **Superseded**: This MEP has been abandoned in favor of another
approach.

Branches and Pull requests
--------------------------
==========================

All development branches containing work on this MEP should be linked to from here.

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).
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).

Abstract
--------
========

The abstract should be a short description of what the MEP will achieve.

Detailed description
--------------------
====================

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.
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.

Implementation
--------------
==============

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.
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.

Backward compatibility
----------------------
======================

This section describes the ways in which the MEP breaks backward incompatibility.

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.
If there were any alternative solutions to solving the same problem,
they should be discussed here, along with a justification for the
chosen approach.
Morty Proxy This is a proxified and sanitized view of the page, visit original site.