| AIP | <to be assigned by the editors> |
|---|---|
| Title | <The AIP title is a few words, not a complete sentence> |
| Author | <a comma separated list of the author's or authors' name + GitHub username (in parenthesis), or name and email (in angle brackets). Example, FirstName LastName (@GitHubUsername), FirstName LastName <foo@bar.com>, FirstName (@GitHubUsername) and GitHubUsername (@GitHubUsername)> |
| Status | Draft [All new proposals should be set to Draft] |
| Type | <Core, Layer 1, Interface, Ecosystem, or Informational> |
| Created | <date created on, in ISO 8601 (yyyy-mm-dd) format> |
| Requires | <AIP number(s)> (*optional) |
This is the suggested template for new AIPs.
Note that an AIP number will be assigned by an editor. When opening a pull request to submit your AIP, please use an abbreviated title in the filename, aip-draft_title_abbrev.md.
The title should be 44 characters or less. It should not repeat the AIP number in title, irrespective of the category.
A short paragraph providing technical summary or brief of the standard and the addressed issue(s). This abstract should be in human-readable format and should be as clear and concise as possible.
The motivation section should describe what motivated the development of the standard. Why should this standard be implemented? How does the Aventus ecosystem benefit from this standard. What prompted the decisions in this standard? What use cases does this standard address?
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.
The specification section should describe the feature as detailed as possible. It should be well detailed describing the syntax and semantics of any new feature. The proposal should be complete, consistent, unambiguous, quantitative, and feasible.
All AIPs that introduce backwards incompatibilities must include a section describing these incompatibilities and their severity. The AIP must explain how the author proposes to deal with these incompatibilities. AIP submissions without a sufficient backwards compatibility treatise may be rejected outright.
If applicable, please include a list of potential test cases to validate an implementation.
An optional section that contains a reference/example implementation that people can use to assist in understanding or implementing this specification. Previous accepted AIP numbers can also be used as reference here.
Each AIP must be labeled as placed in the public domain.