SLEP 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 SLEP will achieve.

Detailed description

This section describes the need for the SLEP. It should describe the existing problem that it is trying to solve and why this SLEP 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 SLEP. 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 SLEP should be linked to from here. (A SLEP 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 SLEP 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 SLEP:

  • This includes links to mailing list threads or relevant GitHub issues.

References and Footnotes