Skip to content

Latest commit

 

History

History
56 lines (34 loc) · 2.36 KB

TEMPLATE.md

File metadata and controls

56 lines (34 loc) · 2.36 KB
aip title author discussions-to (*optional) Status last-call-end-date (*optional) type created updated (*optional) requires (*optional)
(this is determined by the AIP Manager, leave it empty when drafting)
(AIP title)
<a list of the author's or authors' name(s) and/or username(s), or name(s) and email(s). Details are below.>
<a url pointing to the official discussion thread>
<Draft | Last Call | Accepted | Final | Rejected>
<mm/dd/yyyy the last date to leave feedbacks and reviews>
<Standard (Core, Networking, Interface, Application, Framework) | Informational | Process>
<mm/dd/yyyy>
<mm/dd/yyyy>
<AIP number(s)>

AIP-(AIP number or TBD) - (AIP title)

(Please give a temporary file name to your AIP when first drafting it, AIP manager will assign a number to it after reviewing)

Summary

Include a brief description summarizing the intended change. This should be no more than a couple of sentences.

Motivation

Describe the impetus for this change. What does it accomplish? What might occur if we do not accept this proposal?

Rationale

Explain why you submitted this proposal specifically over alternative solutions. Why is this the best possible outcome?

Specification

Describe in detail precisely how this proposal should be implemented. Include proposed design principles that should be followed in implementing this feature. Make the proposal specific enough to allow others to build upon it and perhaps even derive competing implementations.

Reference Implementation

This is an optional yet highly encouraged section where you may include an example of what you are seeking in this proposal. This can be in the form of code, diagrams, or even plain text. IDeally, we have a link to a living repository of code exemplifying the standard, or, for simpler cases, inline code.

Risks and Drawbacks

Express here the potential negative ramifications of taking on this proposal. What are the hazards?

Future Potential

Think through the evolution of this proposal well into the future. How do you see this playing out? What would this proposal result in in one year? In five years?

Suggested implementation timeline

Describe how long you expect the implementation effort to take, perhaps splitting it up into stages or milestones.

Suggested deployment timeline

When should community expect to see this deployed on devnet?

On testnet?

On mainnet?