Overlay Improvement Proposals

Overlay Improvement Proposals (OIPs) describe standards for the Overlay platform, including core protocol specifications, client APIs, and contract standards.

Contributing

  1. Review OIP-0.
  2. Fork the repository by clicking "Fork" in the top right.
  3. Add your OIP to your fork of the repository. There is a template OIP here.
  4. Submit a Pull Request to Overlay's OIPs repository.

Your first PR should be a first draft of the final OIP. 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 OIP 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 OIP as a whole.

If your OIP requires images, the image files should be included in a subdirectory of the `assets` folder for that OIP as follow: assets/oip-X (for OIP X). When linking to an image in the OIP, use relative links such as ../assets/oip-X/image.png.

When you believe your OIP 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 OIP editors will update the state of your OIP to Approved.

OIP status terms