Skip to content

Latest commit

 

History

History
108 lines (70 loc) · 2.87 KB

TEMPLATE.md

File metadata and controls

108 lines (70 loc) · 2.87 KB
SIP-Number <Leave this blank; it will be assigned by a SIP Editor>
Title <Must be short; maximum 64 characters>
Description <Must be one sentence that briefly describes the SIP; maximum 160 characters>
Author <A list of the authors' real names or aliases, plus either their GitHub usernames (in parentheses) or email addresses (in angle brackets)>
Editor <Leave this blank; it will be assigned by a SIP Editor>
Type <Standard, Process, Informational>
Category <Optional, only needed for Type=Standard; Core, Networking, Interface, Framework, Application>
Created <Date created, in ISO 8601 format (YYYY-MM-DD)>
Comments-URI <Leave this blank; it will be assigned by a SIP Editor>
Status <Leave this blank; it will be assigned by a SIP Editor>
Requires <Optional; SIP number(s), comma separated>
REMOVE THIS BLOCK BEFORE SUBMITTING SIP

Please read SIP-1 before using this template.

For new SIPs, this template can be copied and filled in.

Note that some headers will be assigned by the SIP Editor; you should leave these fields blank.

Headers that are not required should be removed from the document.

Before submitting, please delete all comments from the template, including this one.

Abstract

REMOVE THIS BLOCK

This section is mandatory, but is usually expanded as the SIP progresses.

Motivation

REMOVE THIS BLOCK

This section is mandatory.

At the early stages of the SIP, this section is important in order to describe the current problem and how the SIP aims to overcome it.

Specification

REMOVE THIS BLOCK

This section is mandatory.

Rationale

REMOVE THIS BLOCK

This section is mandatory.

It should be used to explain how the SIP's design was arrived at, and what the pros and cons of this approach are.

Backwards Compatibility

REMOVE THIS BLOCK

This section is mandatory, but it may simply state that there are no issues with backwards compatability.

If there are backwards incompatabilities, it should be detailed how these will addressed.

Test Cases

REMOVE THIS BLOCK

This section is optional.

It is usually recommended to not include test cases when first submitting the SIP, and instead focus on the design and problem statement.

Reference Implementation

REMOVE THIS BLOCK

This section is optional.

It is usually recommended to not include a reference implementation when first submitting the SIP, and instead focus on the design and problem statement.

Security Considerations

REMOVE THIS BLOCK

This section is mandatory, but it may simply state "None" if there are no relevant considerations.

Copyright

REMOVE THIS BLOCK

This section is optional but recommended.