Skip to content

Latest commit

 

History

History
28 lines (19 loc) · 1.93 KB

README.md

File metadata and controls

28 lines (19 loc) · 1.93 KB
Raw

Agora Improving Proposals (AIPs)

The Agora Improving Proposals (AIPs) provide design documents to describe new features, new initiatives and new inspirations for the Agora platforms and community.

Contributing

  1. Review the AIP-1.
  2. Fork the Agora's AIPs repository.
  3. Draft your AIP using the AIP template.
  4. Submit a Pull Request to the Agora's AIPs repository.

Your first PR should be a first draft of the final AIP. 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 follows: assets/aip-N (where N is to be replaced with the AIP number). When linking to an image in the AIP, use relative links such as ../assets/aip-1/image.png.

Once your first PR is merged, we will help out merge PRs to draft AIPs. Make sure that you own the draft being edited and the 'author' line of your AIP contains either your GitHub username or your email address inside. If you use your email address, that address must be the one publicly shown on your GitHub profile.

Status and Type

Terms of Status:

  • Draft - an AIP that is undergoing rapid iteration and changes for approval.
  • Active - an AIP that is approved as a candidate for finalization.
  • Final - an AIP that is in the shortlist for implementation.

Terms of Type:

  • Meta - an AIP capable to the whole Agora community and platforms.
  • Feature - an AIP to add a new feature to the Agora platforms and community.
  • Misc - an AIP to describe initiatives, campaigns or any other inspirational proposals.