mStable Improvement Proposals (MIPs) describe standards for the mStable platform, including core protocol specifications, client APIs, and contract standards.
WIP: A browsable version of all current and draft MIPs can be found on the official MIP site.
- Review MIP-1.
- Fork the repository by clicking "Fork" in the top right.
- Add your MIP to your fork of the repository. There is a template MIP here.
- Submit a Pull Request to mStable's MIPs repository.
Your first PR should be a first draft of the final MIP. 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 MIP and assign it a number before merging it. Make sure you include a discussions-to header with the URL to a new thread on forum.mstable.org where people can discuss the MIP as a whole.
If your MIP requires images, the image files should be included in a subdirectory of the assets folder for that MIP as follow: assets/mip-X (for mip X). When linking to an image in the MIP, use relative links such as ../assets/mip-X/image.png.
When you believe your MIP 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 MIP editors will update the state of your MIP to 'Approved'.
- WIP - a MIP that is still being developed.
- Proposed - a MIP that is ready to be reviewed in a governance call.
- Approved - a MIP that has been accepted for implementation by the mStable community.
- Implemented - a MIP that has been released to mainnet.
- Rejected - a MIP that has been rejected.
MIPs must pass some validation tests. The MIP repository ensures this by running tests using html-proofer and mip_validator.
It is possible to run the MIP validator locally:
gem install mip_validator
mip_validator <INPUT_FILES>