Skip to content
This repository has been archived by the owner on Oct 3, 2023. It is now read-only.

Latest commit

 

History

History
47 lines (28 loc) · 2.25 KB

X-AIP.md

File metadata and controls

47 lines (28 loc) · 2.25 KB
title status author shortDescription discussions created updated (*optional)
<AIP title>
WIP
FirstName LastName (@GitHubUsername)
<Short description of AIP>
<Discord Channel or Github issue>
<date created on, in ISO 8601 (yyyy-mm-dd) format>
<date created on, in ISO 8601 (yyyy-mm-dd) format> or N/A

This is the template for AIPs.

Note that the filename should contain the generated identifier by the author. When opening a pull request to submit your AIP, please use an abbreviated title in the filename, identifier-AIP-draft_title_abbrev.md.

The title should be 44 characters or less.

Simple Summary

If you can't explain it simply, you don't understand it well enough. Provide a simplified and layman-accessible explanation of the AIP.

Abstract

A short (~200 word) description of the technical issue being addressed.

Motivation

The motivation is critical for AIPs that want to change Aave. It should clearly explain why the existing protocol specification is inadequate to address the problem that the AIP solves. AIP submissions without sufficient motivation may be rejected outright.

Specification

The technical specification should describe the syntax and semantics of any new feature.

Rationale

The rationale fleshes out the specification by describing what motivated the design and why particular design decisions were made. It should describe alternate designs that were considered and related work, e.g. how the feature is supported in other languages. The rationale may also provide evidence of consensus within the community, and should discuss important objections or concerns raised during discussion.-->

Test Cases

Test cases for an implementation are mandatory for AIPs but can be included with the implementation.

Implementation

The implementations must be completed before any AIP is given status "Implemented", but it need not be completed before the AIP is "Approved". While there is merit to the approach of reaching consensus on the specification and rationale before writing code, the principle of "rough consensus and running code" is still useful when it comes to resolving many discussions of API details.

Copyright

Copyright and related rights waived via CC0.