| iip | title | status | author | discussions-to | created | updated |
|---|---|---|---|---|---|---|
1 |
IIP Purpose and Guidelines |
Implemented |
Pedro Bergamini (@pedrobergamini) |
<URL> |
2021-03-22 |
N/A |
IIP stands for Illuvium Improvement Proposal, it has been adapted from the EIP (Ethereum Improvement Proposal). The purpose of this process is to ensure changes to Illuvium are transparent and well governed. An IIP is a design document providing information to the Illuvium community about a proposed change to the system. The author is responsible for building consensus within the community and documenting dissenting opinions.
ICCP stands for Illuvium Configuration Change Proposal. ICCP's are documents for making a case for modifying one of the system configuration variables. The intent is to provide a clear and detailed history behind each configuration change and the rationale behind it at the time it was implemented. The author of the document is responsible for building consensus within the community and documenting dissenting opinions.
We intend IIPs and ICCPs to be the primary mechanisms for proposing new features, collecting community input on an issue, and for documenting the design decisions for changes to Illuvium. Because they are maintained as text files in a versioned repository, their revision history is the historical record of the feature proposal.
It is highly recommended that a single IIP contain a single key proposal or new idea. The more focused the IIP, the more successful it is likely to be.
An IIP or ICCP must meet certain minimum criteria. It must be a clear and complete description of the proposed enhancement. The enhancement must represent a net improvement.
Parties involved in the process are the author, the IIP editors, the [Illuvium Core Contributors] and the Illuvium community.
Your role as the champion is to write the IIP using the style and format described below, shepherd the discussions in the appropriate forums, and build community consensus around the idea. Following is the process that a successful IIP will move along:
[ WIP ] -> [ PROPOSED ] -> [ APPROVED ] -> [ IMPLEMENTED ] X [ REJECTED ]
Each status change is requested by the IIP author and reviewed by the IIP editors. Use a pull request to update the status. Please include a link to where people should continue discussing your IIP. The IIP editors will process these requests as per the conditions below.
-
Work in progress (WIP) -- Once the champion has asked the Illuvium community whether an idea has any chance of support, they will write a draft IIP as a pull request. Consider including an implementation if this will aid people in studying the IIP.
-
Proposed If agreeable, IIP editor will assign the IIP a number (generally the issue or PR number related to the IIP) and merge your pull request. The IIP editor will not unreasonably deny an IIP. Proposed IIPs will be discussed on governance calls and in Discord. If there is a reasonable level of consensus around the change on the governance call the change will be moved to approved. If the change is contentious a vote of token holders may be held to resolve the issue or approval may be delayed until consensus is reached.
-
Approved -- This IIP has passed community governance and is now being prioritised for development.
-
Implemented -- This IIP has been implemented and deployed to mainnet.
-
Rejected -- This IIP has failed to reach community consensus.
Each IIP or ICCP should have the following parts:
- Preamble - RFC 822 style headers containing metadata about the IIP, including the IIP number, a short descriptive title (limited to a maximum of 44 characters), and the author details.
- Simple Summary - “If you can’t explain it simply, you don’t understand it well enough.” Provide a simplified and layman-accessible explanation of the IIP.
- Abstract - a short (~200 word) description of the technical issue being addressed.
- Motivation (*optional) - The motivation is critical for IIPs that want to change Illuvium. It should clearly explain why the existing specification is inadequate to address the problem that the IIP solves. IIP submissions without sufficient motivation may be rejected outright.
- Specification - The technical specification should describe the syntax and semantics of any new feature.
- Rationale - The rationale fleshes out the specification by describing what motivated the design and why particular design decisions were made. It should describe alternate designs that were considered and related work, e.g. how the feature is supported in other languages. The rationale may also provide evidence of consensus within the community, and should discuss important objections or concerns raised during discussion.
- Test Cases - Test cases may be added during the implementation phase but are required before implementation.
- Copyright Waiver - All IIPs must be in the public domain. See the bottom of this IIP for an example copyright waiver.
IIPs should be written in markdown format.
Image files should be included in a subdirectory of the assets folder for that IIP as follows: assets/iip-X (for iip X). When linking to an image in the IIP, use relative links such as ../assets/iip-X/image.png.
Each IIP must begin with an RFC 822 style header preamble, preceded and followed by three hyphens (---). This header is also termed "front matter" by Jekyll. The headers must appear in the following order. Headers marked with "*" are optional and are described below. All other headers are required.
iip: (this is determined by the IIP editor)
title:
author: <a list of the author's or authors' name(s) and/or username(s), or name(s) and email(s). Details are below.>
* discussions-to: <a url pointing to the official discussion thread.>
status: < WIP | PROPOSED | APPROVED | IMPLEMENTED >
created:
* updated:
* requires: <IIP number(s)>
* resolution: <a url pointing to the resolution of this IIP>
Headers that permit lists must separate elements with commas.
Headers requiring dates will always do so in the format of ISO 8601 (yyyy-mm-dd).
The author header optionally lists the names, email addresses or usernames of the authors/owners of the IIP. Those who prefer anonymity may use a username only, or a first name and a username. The format of the author header value must be:
Random J. User <[email protected]>
or
Random J. User (@username)
if the email address or GitHub username is included, and
Random J. User
if the email address is not given.
While an IIP is in WIP or Proposed status, a discussions-to header will indicate the URL where the IIP is being discussed.
The created header records the date that the IIP was assigned a number. Both headers should be in yyyy-mm-dd format, e.g. 2001-08-14.
The updated header records the date(s) when the IIP was updated with "substantial" changes. This header is only valid for IIPs of Draft and Active status.
IIPs may have a requires header, indicating the IIP numbers that this IIP depends on.
IIPs may include auxiliary files such as diagrams. Such files must be named IIP-XXXX-Y.ext, where “XXXX” is the IIP number, “Y” is a serial number (starting at 1), and “ext” is replaced by the actual file extension (e.g. “png”).
The current IIP editors are
* Pedro Bergamini (@pedrobergamini)
* Basil Gorin (@vgorin)
For each new IIP that comes in, an editor does the following:
- Read the IIP to check if it is ready: sound and complete. The ideas must make technical sense, even if they don't seem likely to get to final status.
- The title should accurately describe the content.
- Check the IIP for language (spelling, grammar, sentence structure, etc.), markup (Github flavored Markdown), code style
If the IIP isn't ready, the editor will send it back to the author for revision, with specific instructions.
Once the IIP is ready for the repository, the IIP editor will:
-
Assign an IIP number (generally the PR number or, if preferred by the author, the Issue # if there was discussion in the Issues section of this repository about this IIP)
-
Merge the corresponding pull request
-
Send a message back to the IIP author with the next step.
Many IIPs are written and maintained by developers with write access to the Ethereum codebase. The IIP editors monitor IIP changes, and correct any structure, grammar, spelling, or markup mistakes we see.
The editors don't pass judgment on IIPs. We merely do the administrative & editorial part.
The IIP document was derived heavily from the EIP Ethereum Improvement Proposal document in many places text was simply copied and modified. Any comments about the IIP document should be directed to the IIP editors. The history of the EIP is quoted below from the EIP document for context:
- "This document (EIP) was derived heavily from Bitcoin's BIP-0001 written by Amir Taaki which in turn was derived from Python's PEP-0001. In many places text was simply copied and modified. Although the PEP-0001 text was written by Barry Warsaw, Jeremy Hylton, and David Goodger, they are not responsible for its use..." *
June 10, 2019: IIP 1 has been drafted and submitted as a PR.
See the revision history for further details, which is also available by clicking on the History button in the top right of the IIP.
Copyright and related rights waived via CC0.