Contributing

If you plan to add a new Aave Improvement Proposal (AIP) follow this guide:

1. Fork this repository by clicking 'Fork' in the top right.
2. Install the project dependencies: npm install. Note the repository works with Node v16.
3. Create a new aip file with an UPPERCASE_IDENTIFIER: AAVESOME_AIP.md following the aip template inside content/aips/ directory.
4. Submit a Pull Request (PR) to the main.

Your PR must follow the formatting criteria enforced by the build, as detailed in the AIP template. Make sure you include a discussions-to header with the URL to a discussion forum or open GitHub issue where people can discuss the AIP as a whole.

If your AIP requires images, the image files should be included in a subdirectory of the assets folder for that AIP as follow: assets/[UPPERCASE_IDENTIFIER] (for AIP AAVESOME_AIP it would be assets/AAVESOME_AIP/). When linking to an image in the AIP, you must use the full url for the raw content, for example https://raw.githubusercontent.com/aave/aip/main/content/assets/[UPPERCASE_IDENTIFIER]/image.png.

Contribution example

Let's imagine we believe a parameter of the AAVE reserve should be changed for the common good of the community, in particular, an increase of the liquidation bonus. If we propose the change to the community and consensus is reached, we will make this happen.

First of all, an Aave Request for Comment (ARC) had to be initiated in the Governance Forum, so the community can participate and provide feedback. Here you can find instructions about it.

If the community is aligned with our change proposal, we can start working on the AIP. There is an example of the AIP at the sample-aip branch and the Pull Request (PR) to the main branch that it is needed to be done.

And Voila, we have created our AIP for the proposal!

Now it's time to prepare everything for the proposal submission. Some AIPs are more sophisticated than others, so need tests and even some contract code. In this case, we would just need to prepare the call to the Governance contract with adequate parameters, which can be done with a Payload contract or directly using calldatas. We recommend using a Payload contract since it is much more clarifying, transparent and less error-prone than calldatas.

Here you can find two examples of Payload contracts:

• AssetListingProposalGenericExecutor - Payload contract to add new assets to the Aave protocol.
• ProposalIncentivesExecutor - Payload contract used to bootstrap the incentives program.

Note: If the proposal is an asset listing here you have some helpful docs about the process to follow.

Once all is ready for the proposal, submit the proposal to Aave Governance.

AIPs