Ampleforth Improvement Proposals (AIPs) describe standards for the Ampleforth platform, including core protocol specifications, client APIs, and contract standards.
Ampleforth Configuration Change Proposals(ACCPs) are similar to AIPs, but concern modifications to system configuration values such as equilibrium_threshold and the orchestrator transactions list. ACCPs live in the same repository and website as AIPs do, but have a slightly different specification.
- Review AIP-1 or ACCP-1.
- Fork the repository by clicking "Fork" in the top right.
- Add your document to your fork of the repository. There is a template AIP and ACCP.
- Submit a Pull Request to Ampleforth's AIPs repository.
Your first PR (Pull Request) should be a first draft of the final AIP. It must meet the
formatting criteria enforced by the build (largely, correct metadata in the
header). An editor will manually review the first PR for a new AIP and assign
it a number before merging it. 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/aip-X (for aip X). When linking to an image in the
AIP, use relative links such as
When you believe your AIP is mature and ready to progress past the WIP phase,
you should ask to have your issue added to the next governance call where it
can be discussed for inclusion in a future platform upgrade. If the community
agrees to include it, the AIP editors will update the state of your AIP to
AIP status terms
- WIP - a AIP that is still being developed.
- Proposed - a AIP that is ready to be reviewed in a governance call.
- Approved - a AIP that has been accepted for implementation by the Ampleforth community.
- Implemented - a AIP that has been released to mainnet.
- Rejected - a AIP that has been rejected.