Skip to content

Latest commit

 

History

History
66 lines (39 loc) · 1.81 KB

APEtemplate.rst

File metadata and controls

66 lines (39 loc) · 1.81 KB

<APE title here>

author: <your name>

date-created: 2013 November 5 <replace with the date you submit the APE>

date-last-revised: 2013 December 17 <keep this up to date anytime something changes>

date-accepted: 2014 January 20 <replace with accepted date>

type: <one of these three: Standard Track, Informational, Process>

status: Discussion

Abstract

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

Detailed description

This section describes the need for the APE. It should describe the existing problem that it is trying to solve and why this APE makes the situation better. It should include examples of how the new functionality would be used and perhaps some use cases.

Branches and pull requests

Any pull requests or development branches containing work on this APE should be linked to from here. (An APE does not need to be implemented in a single pull request if it makes sense to implement it in discrete phases). If no code is yet implemented, just put "N/A"

Implementation

This section lists the major steps required to implement the APE. 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 APE 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.

Decision rationale

<To be filled in by the coordinating committee when the APE is accepted or rejected>