From 5a4a19c1c922498e02c8f5f535dab89a3c8e4067 Mon Sep 17 00:00:00 2001 From: William Entriken Date: Fri, 18 May 2018 17:04:29 -0400 Subject: [PATCH 01/25] Add new two-week review process to EIPs --- EIPS/eip-1.md | 181 +++++++++++++++++++++++--------------------------- 1 file changed, 82 insertions(+), 99 deletions(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index e6b2410377fb5..5941bc63f45ad 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -3,121 +3,108 @@ eip: 1 title: EIP Purpose and Guidelines status: Active type: Meta -author: Martin Becze , Hudson Jameson +author: Martin Becze , Hudson Jameson , William Entriken created: 2015-10-27, 2017-02-01 --- -What is an EIP? --------------- +## What is an EIP? EIP stands for Ethereum Improvement Proposal. An EIP is a design document providing information to the Ethereum community, or describing a new feature for Ethereum or its processes or environment. The EIP should provide a concise technical specification of the feature and a rationale for the feature. The EIP author is responsible for building consensus within the community and documenting dissenting opinions. -EIP Rationale -------------- +## EIP Rationale We intend EIPs to be the primary mechanisms for proposing new features, for collecting community input on an issue, and for documenting the design decisions that have gone into Ethereum. Because the EIPs are maintained as text files in a versioned repository, their revision history is the historical record of the feature proposal. For Ethereum implementers, EIPs are a convenient way to track the progress of their implementation. Ideally each implementation maintainer would list the EIPs that they have implemented. This will give end users a convenient way to know the current status of a given implementation or library. -EIP Types ---------- +## EIP Types There are three types of EIP: -- A **Standard Track EIP** describes any change that affects most or all Ethereum implementations, such as a change to the the network protocol, a change in block or transaction validity rules, proposed application standards/conventions, or any change or addition that affects the interoperability of applications using Ethereum. Furthermore Standard EIPs can be broken down into the following categories. - - **Core** - improvements requiring a consensus fork (e.g. [EIP5], [EIP101]), as well as changes that are not necessarily consensus critical but may be relevant to [“core dev” discussions](https://github.com/ethereum/pm) (for example, [EIP90], and the miner/node strategy changes 2, 3, and 4 of [EIP86]). - - **Networking** - includes improvements around [devp2p] ([EIP8]) and [Light Ethereum Subprotocol], as well as proposed improvements to network protocol specifications of [whisper] and [swarm]. - - **Interface** - includes improvements around client [API/RPC] specifications and standards, and also certain language-level standards like method names ([EIP59], [EIP6]) and [contract ABIs]. The label “interface” aligns with the [interfaces repo] and discussion should primarily occur in that repository before an EIP is submitted to the EIPs repository. - - **ERC** - application-level standards and conventions, including contract standards such as token standards ([ERC20]), name registries ([ERC26], [ERC137]), URI schemes ([ERC67]), library/package formats ([EIP82]), and wallet formats ([EIP75], [EIP85]). +- A **Standard Track EIP** describes any change that affects most or all Ethereum implementations, such as a change to the the network protocol, a change in block or transaction validity rules, proposed application standards/conventions, or any change or addition that affects the interoperability of applications using Ethereum. Furthermore Standard EIPs can be broken down into the following categories. + - **Core** — improvements requiring a consensus fork (e.g. [EIP5], [EIP101]), as well as changes that are not necessarily consensus critical but may be relevant to [“core dev” discussions](https://github.com/ethereum/pm) (for example, [EIP90], and the miner/node strategy changes 2, 3, and 4 of [EIP86]). + - **Networking** — includes improvements around [devp2p] ([EIP8]) and [Light Ethereum Subprotocol], as well as proposed improvements to network protocol specifications of [whisper] and [swarm]. + - **Interface** — includes improvements around client [API/RPC] specifications and standards, and also certain language-level standards like method names ([EIP59], [EIP6]) and [contract ABIs]. The label “interface” aligns with the [interfaces repo] and discussion should primarily occur in that repository before an EIP is submitted to the EIPs repository. + - **ERC** — application-level standards and conventions, including contract standards such as token standards ([ERC20]), name registries ([ERC26], [ERC137]), URI schemes ([ERC67]), library/package formats ([EIP82]), and wallet formats ([EIP75], [EIP85]). +- An **Informational EIP** describes an Ethereum design issue, or provides general guidelines or information to the Ethereum community, but does not propose a new feature. Informational EIPs do not necessarily represent Ethereum community consensus or a recommendation, so users and implementers are free to ignore Informational EIPs or follow their advice. +- A **Meta EIP** describes a process surrounding Ethereum or proposes a change to (or an event in) a process. Process EIPs are like Standards Track EIPs but apply to areas other than the Ethereum protocol itself. They may propose an implementation, but not to Ethereum's codebase; they often require community consensus; unlike Informational EIPs, they are more than recommendations, and users are typically not free to ignore them. Examples include procedures, guidelines, changes to the decision-making process, and changes to the tools or environment used in Ethereum development. Any meta-EIP is also considered a Process EIP. -- An **Informational EIP** describes an Ethereum design issue, or provides general guidelines or information to the Ethereum community, but does not propose a new feature. Informational EIPs do not necessarily represent Ethereum community consensus or a recommendation, so users and implementers are free to ignore Informational EIPs or follow their advice. -- A **Meta EIP** describes a process surrounding Ethereum or proposes a change to (or an event in) a process. Process EIPs are like Standards Track EIPs but apply to areas other than the Ethereum protocol itself. They may propose an implementation, but not to Ethereum's codebase; they often require community consensus; unlike Informational EIPs, they are more than recommendations, and users are typically not free to ignore them. Examples include procedures, guidelines, changes to the decision-making process, and changes to the tools or environment used in Ethereum development. Any meta-EIP is also considered a Process EIP. +## EIP Work Flow -EIP Work Flow -------------- +The normal process is: -The EIP repository editors change the EIPs status. Please send all EIP-related email to the EIP editors or preferably (e.g. for public transparency) you can ping one of the Editors that is involved with your pull request (PR); they are listed under [EIP editors below](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-editors). Also see [EIP Editor Responsibilities & Workflow](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-editor-responsibilities-and-workflow). +``` +[ A pull request ] -> [ DRAFT ] -> [ TWO WEEK REVIEW ] -> [ FINAL ] +``` + +The [EIP editors](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-editors) update the status of EIPs at the request of EIP authors. Please ping the editors by mentioning them in your pull request or send them an email. See alse [EIP Editor Responsibilities & Workflow](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-editor-responsibilities-and-workflow). The EIP process begins with a new idea for Ethereum. It is highly recommended that a single EIP contain a single key proposal or new idea. The more focused the EIP, the more successful it tends to be. A change to one client doesn't require an EIP; a change that affects multiple clients, or defines a standard for multiple apps to use, does. The EIP editor reserves the right to reject EIP proposals if they appear too unfocused or too broad. If in doubt, split your EIP into several well-focused ones. Each EIP must have a champion—someone who writes the EIP using the style and format described below, shepherds the discussions in the appropriate forums, and attempts to build community consensus around the idea. -Vetting an idea publicly before going as far as writing an EIP is meant to save the potential author time. Asking the Ethereum community first if an idea is original helps prevent too much time being spent on something that is guaranteed to be rejected based on prior discussions (searching the Internet does not always do the trick). It also helps to make sure the idea is applicable to the entire community and not just the author. Just because an idea sounds good to the author does not mean it will work for most people in most areas where Ethereum is used. Examples of appropriate public forums to gauge interest around your EIP include [the Ethereum subreddit], [the Issues section of this repository], and [one of the Ethereum Gitter chat rooms]. In particular, [the Issues section of this repository] is an excellent place to discuss your proposal with the community and start creating more formalized language around your EIP. +Vetting an idea publicly before going as far as writing an EIP is meant to save the potential author time. Ask the Ethereum community first if an idea is original to avoid wasting time on something that will be be rejected based on prior research (searching the Internet does not always do the trick). It also helps to make sure the idea is applicable to the entire community and not just the author. Just because an idea sounds good to the author does not mean it will work for most people in most areas where Ethereum is used. Examples of appropriate public forums to gauge interest around your EIP include [the Ethereum subreddit], [the Issues section of this repository], and [one of the Ethereum Gitter chat rooms]. In particular, [the Issues section of this repository] is an excellent place to discuss your proposal with the community and start creating more formalized language around your EIP. Once the champion has asked the Ethereum community whether an idea has any chance of acceptance a draft EIP should be presented as a [pull request]. -If the EIP editors approve the EIP ([see the EIP editors workflow section below for details](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-editor-responsibilities-and-workflow)) and the authors are happy for it to be merged as a draft, the EIP editor will assign the EIP a number (generally the issue or PR number related to the EIP) and merge your pull request. The EIP editor will not unreasonably deny an EIP. (EIP authors can request for it to be merged after they have finished editing it, and editors can ask if they have finished editing it and would like it to be merged. This prevents merging an EIP when more edits are intended to be made by the author, although it can always be edited after merging.) Reasons for denying EIP status include duplication of effort, being technically unsound, not providing proper motivation or addressing backwards compatibility, or not in keeping with the [Ethereum philosophy](https://github.com/ethereum/wiki/wiki/White-Paper#philosophy). +If the EIP editors accept the EIP as a draft ([see the EIP editors workflow section below for details](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-editor-responsibilities-and-workflow)) and the authors are happy for it to be merged as a draft, the EIP editor will assign the EIP a number (generally the issue or PR number related to the EIP) and merge your pull request. The EIP editor will not unreasonably deny an EIP. Reasons for denying EIP status include duplication of effort, being technically unsound, not providing proper motivation or addressing backwards compatibility, or not in keeping with the [Ethereum philosophy](https://github.com/ethereum/wiki/wiki/White-Paper#philosophy). Once the first draft has been merged, you may submit follow-up pull requests with further changes to your draft until such point as you believe the EIP to be mature and ready to proceed to the next phase. -Standards Track EIPs consist of three parts, a design document, implementation, and finally if warranted an update to the [formal specification]. The EIP should be reviewed and accepted before an implementation is begun, unless an implementation will aid people in studying the EIP. Standards Track Core EIPs must be implemented in at least three viable Ethereum clients before it can be considered Final. +Standards Track EIPs consist of three parts, a design document, implementation, and finally if warranted an update to the [formal specification]. Standards Track Core EIPs must be implemented in at least three viable Ethereum clients before it can be considered Final. For an EIP to be accepted it must meet certain minimum criteria. It must be a clear and complete description of the proposed enhancement. The enhancement must represent a net improvement. The proposed implementation, if applicable, must be solid and must not complicate the protocol unduly. -Once an EIP has been accepted, the implementations must be completed. When the implementation is complete and accepted by the community, the status will be changed to “Final”. - -An EIP can also be assigned status “Deferred”. The EIP author or editor can assign the EIP this status when no progress is being made on the EIP. Once an EIP is deferred, the EIP editor can re-assign it to draft status. - -An EIP can also be “Rejected”. Perhaps after all is said and done it was not a good idea. It is still important to have a record of this fact. - -EIPs can also be superseded by a different EIP, rendering the original obsolete. - -The possible paths of the status of EIPs are as follows: - -![EIP Process](../assets/eip-1/process.png) +An EIP in draft status must have implementations to be considered for promotion to the next status. When no further changes are planned and adove rules are met, the champion will request, and the editor will approve a change to "two week review" status. This EIP will listed prominently on the http://eips.ethereum.org/ website (subscribe via RSS here [TODO LATER, ADD A LINK HERE]). After the review period, if all issues are resolved, then the editor will change to final status. Or if issues remain then it may be returned to draft. -Some Informational and Process EIPs may also have a status of “Active” if they are never meant to be completed, e.g. EIP 1 (this EIP). +Other exceptional outcomes for EIPS include "deferred", a temporary status for drafts which have no recent progress, and "rejected" which records an EIP that is fundamentally broken and will not be implemented. Also, "active" denotes an EIP that is in effect but which may be updated without changing its EIP number. A "final" EIP should be updated on to correct errata, although another EIP may wish to supercede it — in that case you would have an original and succesor EIP both in final status. -What belongs in a successful EIP? ---------------------------------- +## What belongs in a successful EIP? Each EIP should have the following parts: -- Preamble - RFC 822 style headers containing metadata about the EIP, including the EIP number, a short descriptive title (limited to a maximum of 44 characters), and the author details. See [below](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-header-preamble) for 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 EIP. +- Preamble - RFC 822 style headers containing metadata about the EIP, including the EIP number, a short descriptive title (limited to a maximum of 44 characters), and the author details. See [below](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-header-preamble) for 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 EIP. -- Abstract - a short (~200 word) description of the technical issue being addressed. +- Abstract - a short (~200 word) description of the technical issue being addressed. -- Motivation (*optional) - The motivation is critical for EIPs that want to change the Ethereum protocol. It should clearly explain why the existing protocol specification is inadequate to address the problem that the EIP solves. EIP submissions without sufficient motivation may be rejected outright. +- Motivation (*optional) - The motivation is critical for EIPs that want to change the Ethereum protocol. It should clearly explain why the existing protocol specification is inadequate to address the problem that the EIP solves. EIP submissions without sufficient motivation may be rejected outright. -- Specification - The technical specification should describe the syntax and semantics of any new feature. The specification should be detailed enough to allow competing, interoperable implementations for any of the current Ethereum platforms (cpp-ethereum, go-ethereum, parity, ethereumJ, ethereumjs-lib, [and others](https://github.com/ethereum/wiki/wiki/Clients). +- Specification - The technical specification should describe the syntax and semantics of any new feature. The specification should be detailed enough to allow competing, interoperable implementations for any of the current Ethereum platforms (cpp-ethereum, go-ethereum, parity, ethereumJ, ethereumjs-lib, [and others](https://github.com/ethereum/wiki/wiki/Clients). -- 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. +- 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. -- Backwards Compatibility - All EIPs that introduce backwards incompatibilities must include a section describing these incompatibilities and their severity. The EIP must explain how the author proposes to deal with these incompatibilities. EIP submissions without a sufficient backwards compatibility treatise may be rejected outright. +- Backwards Compatibility - All EIPs that introduce backwards incompatibilities must include a section describing these incompatibilities and their severity. The EIP must explain how the author proposes to deal with these incompatibilities. EIP submissions without a sufficient backwards compatibility treatise may be rejected outright. -- Test Cases - Test cases for an implementation are mandatory for EIPs that are affecting consensus changes. Other EIPs can choose to include links to test cases if applicable. +- Test Cases - Test cases for an implementation are mandatory for EIPs that are affecting consensus changes. Other EIPs can choose to include links to test cases if applicable. -- Implementations - The implementations must be completed before any EIP is given status “Final”, but it need not be completed before the EIP is accepted. While there is merit to the approach of reaching consensus on the specification and rationale before writing code, the principle of “rough consensus and running code” is still useful when it comes to resolving many discussions of API details. +- Implementations - The implementations must be completed before any EIP is given status “Final”, but it need not be completed before the EIP is accepted. While there is merit to the approach of reaching consensus on the specification and rationale before writing code, the principle of “rough consensus and running code” is still useful when it comes to resolving many discussions of API details. -- Copyright Waiver - All EIPs must be in the public domain. See the bottom of this EIP for an example copyright waiver. +- Copyright Waiver - All EIPs must be in the public domain. See the bottom of this EIP for an example copyright waiver. -EIP Formats and Templates -------------------------- +## EIP Formats and Templates EIPs should be written in [markdown] format. Image files should be included in a subdirectory of the `assets` folder for that EIP as follow: `assets/eip-X` (for eip **X**). When linking to an image in the EIP, use relative links such as `../assets/eip-X/image.png`. -EIP Header Preamble -------------------- +## EIP Header Preamble Each EIP must begin with an RFC 822 style header preamble, preceded and followed by three hyphens ('---'). The headers must appear in the following order. Headers marked with "*" are optional and are described below. All other headers are required. @@ -131,6 +118,8 @@ Each EIP must begin with an RFC 822 style header preamble, preceded and followed ` status: ` +`* review-period:`Starting YYYY-MM-DD, ending YYYY-MM-DD + ` type: ` ` * category `: @@ -146,6 +135,7 @@ Each EIP must begin with an RFC 822 style header preamble, preceded and followed ` * resolution: ` #### Author header + The author header optionally lists the names, email addresses or usernames of the authors/owners of the EIP. 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 <address@dom.ain> @@ -176,20 +166,17 @@ EIPs may also have a superseded-by header indicating that an EIP has been render Headers that permit lists must separate elements with commas. -Auxiliary Files ---------------- +## Auxiliary Files EIPs may include auxiliary files such as diagrams. Such files must be named EIP-XXXX-Y.ext, where “XXXX” is the EIP number, “Y” is a serial number (starting at 1), and “ext” is replaced by the actual file extension (e.g. “png”). -Transferring EIP Ownership --------------------------- +## Transferring EIP Ownership It occasionally becomes necessary to transfer ownership of EIPs to a new champion. In general, we'd like to retain the original author as a co-author of the transferred EIP, but that's really up to the original author. A good reason to transfer ownership is because the original author no longer has the time or interest in updating it or following through with the EIP process, or has fallen off the face of the 'net (i.e. is unreachable or isn't responding to email). A bad reason to transfer ownership is because you don't agree with the direction of the EIP. We try to build consensus around an EIP, but if that's not possible, you can always submit a competing EIP. If you are interested in assuming ownership of an EIP, send a message asking to take over, addressed to both the original author and the EIP editor. If the original author doesn't respond to email in a timely manner, the EIP editor will make a unilateral decision (it's not like such decisions can't be reversed :)). -EIP Editors ------------ +## EIP Editors The current EIP editors are @@ -205,36 +192,33 @@ The current EIP editors are ` * Martin Becze (@wanderer)` - -EIP Editor Responsibilities and Workflow --------------------------------------- +## EIP Editor Responsibilities and Workflow For each new EIP that comes in, an editor does the following: -- Read the EIP to check if it is ready: sound and complete. The ideas must make technical sense, even if they don't seem likely to be accepted. -- The title should accurately describe the content. -- Check the EIP for language (spelling, grammar, sentence structure, etc.), markup (Github flavored Markdown), code style +- Read the EIP to check if it is ready: sound and complete. The ideas must make technical sense, even if they don't seem likely to be accepted. +- The title should accurately describe the content. +- Check the EIP for language (spelling, grammar, sentence structure, etc.), markup (Github flavored Markdown), code style If the EIP isn't ready, the editor will send it back to the author for revision, with specific instructions. Once the EIP is ready for the repository, the EIP editor will: -- Assign an EIP 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 EIP) +- Assign an EIP 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 EIP) -- Accept the corresponding pull request +- Accept the corresponding pull request -- Send a message back to the EIP author with the next step. +- Send a message back to the EIP author with the next step. Many EIPs are written and maintained by developers with write access to the Ethereum codebase. The EIP editors monitor EIP changes, and correct any structure, grammar, spelling, or markup mistakes we see. The editors don't pass judgment on EIPs. We merely do the administrative & editorial part. -History -------- +## History This document 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 in the Ethereum Improvement Process, and should not be bothered with technical questions specific to Ethereum or the EIP. Please direct all comments to the EIP editors. @@ -248,37 +232,36 @@ See [the revision history for further details](https://github.com/ethereum/EIPs/ ### Bibliography - [EIP5]: https://github.com/ethereum/EIPs/blob/master/EIPS/eip-5.md - [EIP101]: https://github.com/ethereum/EIPs/issues/28 - [EIP90]: https://github.com/ethereum/EIPs/issues/90 - [EIP86]: https://github.com/ethereum/EIPs/issues/86#issue-145324865 - [devp2p]: https://github.com/ethereum/wiki/wiki/%C3%90%CE%9EVp2p-Wire-Protocol - [EIP8]: https://github.com/ethereum/EIPs/blob/master/EIPS/eip-8.md - [Light Ethereum Subprotocol]: https://github.com/ethereum/wiki/wiki/Light-client-protocol - [whisper]: https://github.com/ethereum/go-ethereum/wiki/Whisper-Overview - [swarm]: https://github.com/ethereum/go-ethereum/pull/2959 - [API/RPC]: https://github.com/ethereum/wiki/wiki/JSON-RPC - [EIP59]: https://github.com/ethereum/EIPs/issues/59 - [EIP6]: https://github.com/ethereum/EIPs/blob/master/EIPS/eip-6.md - [contract ABIs]: https://github.com/ethereum/wiki/wiki/Ethereum-Contract-ABI - [interfaces repo]: https://github.com/ethereum/interfaces - [ERC20]: https://github.com/ethereum/EIPs/issues/20 - [ERC26]: https://github.com/ethereum/EIPs/issues/26 - [ERC137]: https://github.com/ethereum/EIPs/issues/137 - [ERC67]: https://github.com/ethereum/EIPs/issues/67 - [EIP82]: https://github.com/ethereum/EIPs/issues/82 - [EIP75]: https://github.com/ethereum/EIPs/issues/75 - [EIP85]: https://github.com/ethereum/EIPs/issues/85 - [the Ethereum subreddit]: https://www.reddit.com/r/ethereum/ - [one of the Ethereum Gitter chat rooms]: https://gitter.im/ethereum/ - [pull request]: https://github.com/ethereum/EIPs/pulls - [formal specification]: https://github.com/ethereum/yellowpaper - [the Issues section of this repository]: https://github.com/ethereum/EIPs/issues - [markdown]: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet - [Bitcoin's BIP-0001]: https://github.com/bitcoin/bips - [Python's PEP-0001]: https://www.python.org/dev/peps/ - -Copyright ---------- +[EIP5]: https://github.com/ethereum/EIPs/blob/master/EIPS/eip-5.md +[EIP101]: https://github.com/ethereum/EIPs/issues/28 +[EIP90]: https://github.com/ethereum/EIPs/issues/90 +[EIP86]: https://github.com/ethereum/EIPs/issues/86#issue-145324865 +[devp2p]: https://github.com/ethereum/wiki/wiki/%C3%90%CE%9EVp2p-Wire-Protocol +[EIP8]: https://github.com/ethereum/EIPs/blob/master/EIPS/eip-8.md +[Light Ethereum Subprotocol]: https://github.com/ethereum/wiki/wiki/Light-client-protocol +[whisper]: https://github.com/ethereum/go-ethereum/wiki/Whisper-Overview +[swarm]: https://github.com/ethereum/go-ethereum/pull/2959 +[API/RPC]: https://github.com/ethereum/wiki/wiki/JSON-RPC +[EIP59]: https://github.com/ethereum/EIPs/issues/59 +[EIP6]: https://github.com/ethereum/EIPs/blob/master/EIPS/eip-6.md +[contract ABIs]: https://github.com/ethereum/wiki/wiki/Ethereum-Contract-ABI +[interfaces repo]: https://github.com/ethereum/interfaces +[ERC20]: https://github.com/ethereum/EIPs/issues/20 +[ERC26]: https://github.com/ethereum/EIPs/issues/26 +[ERC137]: https://github.com/ethereum/EIPs/issues/137 +[ERC67]: https://github.com/ethereum/EIPs/issues/67 +[EIP82]: https://github.com/ethereum/EIPs/issues/82 +[EIP75]: https://github.com/ethereum/EIPs/issues/75 +[EIP85]: https://github.com/ethereum/EIPs/issues/85 +[the Ethereum subreddit]: https://www.reddit.com/r/ethereum/ +[one of the Ethereum Gitter chat rooms]: https://gitter.im/ethereum/ +[pull request]: https://github.com/ethereum/EIPs/pulls +[formal specification]: https://github.com/ethereum/yellowpaper +[the Issues section of this repository]: https://github.com/ethereum/EIPs/issues +[markdown]: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet +[Bitcoin's BIP-0001]: https://github.com/bitcoin/bips +[Python's PEP-0001]: https://www.python.org/dev/peps/ + +## Copyright Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/). From c84ee64c6e97c3689ebd52f09cce4fd9159274e8 Mon Sep 17 00:00:00 2001 From: William Entriken Date: Mon, 21 May 2018 12:56:56 -0700 Subject: [PATCH 02/25] Add ACCEPTED status, thanks @arachnid --- EIPS/eip-1.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 5941bc63f45ad..1a088fccc31c3 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -34,7 +34,7 @@ There are three types of EIP: The normal process is: ``` -[ A pull request ] -> [ DRAFT ] -> [ TWO WEEK REVIEW ] -> [ FINAL ] +[ A pull request ] -> [ DRAFT ] -> [ TWO WEEK REVIEW ] -> [APPROVED] -> [ FINAL ] ``` The [EIP editors](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-editors) update the status of EIPs at the request of EIP authors. Please ping the editors by mentioning them in your pull request or send them an email. See alse [EIP Editor Responsibilities & Workflow](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-editor-responsibilities-and-workflow). @@ -55,7 +55,9 @@ Standards Track EIPs consist of three parts, a design document, implementation, For an EIP to be accepted it must meet certain minimum criteria. It must be a clear and complete description of the proposed enhancement. The enhancement must represent a net improvement. The proposed implementation, if applicable, must be solid and must not complicate the protocol unduly. -An EIP in draft status must have implementations to be considered for promotion to the next status. When no further changes are planned and adove rules are met, the champion will request, and the editor will approve a change to "two week review" status. This EIP will listed prominently on the http://eips.ethereum.org/ website (subscribe via RSS here [TODO LATER, ADD A LINK HERE]). After the review period, if all issues are resolved, then the editor will change to final status. Or if issues remain then it may be returned to draft. +An EIP in draft status must have implementations to be considered for promotion to the next status. When no further changes are planned and adove rules are met, the champion will request, and the editor will approve a change to "two week review" status. This EIP will listed prominently on the http://eips.ethereum.org/ website (subscribe via RSS here [TODO LATER, ADD A LINK HERE]). After the review period, if all issues are resolved, then the editor will proceed to the next status; if issues remain then it may be returned to draft. + +Standards track EIPs of type "Core" that pass "two week review" will be sent to the core devs meeting for review. A successful review will lead to "Accepted" status. And when implemented in at least two clients totalling at least 50% of deployed nodes, and all pass a common set of test suites, the status of the EIP is updated to "Final". Alternatively, non-core EIPS will proceed directly from "two week review" to "final". Other exceptional outcomes for EIPS include "deferred", a temporary status for drafts which have no recent progress, and "rejected" which records an EIP that is fundamentally broken and will not be implemented. Also, "active" denotes an EIP that is in effect but which may be updated without changing its EIP number. A "final" EIP should be updated on to correct errata, although another EIP may wish to supercede it — in that case you would have an original and succesor EIP both in final status. From d6bed1bc5454a241d9b482419274fb228d755f80 Mon Sep 17 00:00:00 2001 From: William Entriken Date: Mon, 21 May 2018 13:00:16 -0700 Subject: [PATCH 03/25] Use last call, thanks @arachnid --- EIPS/eip-1.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 1a088fccc31c3..e00af54a41531 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -34,7 +34,7 @@ There are three types of EIP: The normal process is: ``` -[ A pull request ] -> [ DRAFT ] -> [ TWO WEEK REVIEW ] -> [APPROVED] -> [ FINAL ] +[ A pull request ] -> [ DRAFT ] -> [ LAST CALL ] -> [APPROVED] -> [ FINAL ] ``` The [EIP editors](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-editors) update the status of EIPs at the request of EIP authors. Please ping the editors by mentioning them in your pull request or send them an email. See alse [EIP Editor Responsibilities & Workflow](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-editor-responsibilities-and-workflow). @@ -55,9 +55,9 @@ Standards Track EIPs consist of three parts, a design document, implementation, For an EIP to be accepted it must meet certain minimum criteria. It must be a clear and complete description of the proposed enhancement. The enhancement must represent a net improvement. The proposed implementation, if applicable, must be solid and must not complicate the protocol unduly. -An EIP in draft status must have implementations to be considered for promotion to the next status. When no further changes are planned and adove rules are met, the champion will request, and the editor will approve a change to "two week review" status. This EIP will listed prominently on the http://eips.ethereum.org/ website (subscribe via RSS here [TODO LATER, ADD A LINK HERE]). After the review period, if all issues are resolved, then the editor will proceed to the next status; if issues remain then it may be returned to draft. +An EIP in draft status must have implementations to be considered for promotion to the next status. When no further changes are planned and adove rules are met, the champion will request, and the editor will approve a change to "Last Call" status. This EIP will listed prominently on the http://eips.ethereum.org/ website (subscribe via RSS here [TODO LATER, ADD A LINK HERE]). After the review period, if all issues are resolved, then the editor will proceed to the next status; if issues remain then it may be returned to draft. -Standards track EIPs of type "Core" that pass "two week review" will be sent to the core devs meeting for review. A successful review will lead to "Accepted" status. And when implemented in at least two clients totalling at least 50% of deployed nodes, and all pass a common set of test suites, the status of the EIP is updated to "Final". Alternatively, non-core EIPS will proceed directly from "two week review" to "final". +Standards track EIPs of type "Core" that pass "Last Call" will be sent to the core devs meeting for review. A successful review will lead to "Accepted" status. And when implemented in at least two clients totalling at least 50% of deployed nodes, and all pass a common set of test suites, the status of the EIP is updated to "Final". Alternatively, non-core EIPS will proceed directly from "Last Call" to "Final". Other exceptional outcomes for EIPS include "deferred", a temporary status for drafts which have no recent progress, and "rejected" which records an EIP that is fundamentally broken and will not be implemented. Also, "active" denotes an EIP that is in effect but which may be updated without changing its EIP number. A "final" EIP should be updated on to correct errata, although another EIP may wish to supercede it — in that case you would have an original and succesor EIP both in final status. From 0b4245e30e392f06a27f99f3ae25771919334db4 Mon Sep 17 00:00:00 2001 From: William Entriken Date: Thu, 24 May 2018 22:41:58 -0400 Subject: [PATCH 04/25] Add other authors --- EIPS/eip-1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 393dc2f06b1af..8d7ace4b2c69a 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -3,7 +3,7 @@ eip: 1 title: EIP Purpose and Guidelines status: Active type: Meta -author: Martin Becze , Hudson Jameson , William Entriken +author: Martin Becze , Hudson Jameson , [and others](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md). created: 2015-10-27, 2017-02-01 --- From d09dd90dc221d0bb5f19a98b69edb35095739777 Mon Sep 17 00:00:00 2001 From: William Entriken Date: Thu, 24 May 2018 22:48:17 -0400 Subject: [PATCH 05/25] Re-add "request to merge" --- EIPS/eip-1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 8d7ace4b2c69a..7675da18c85bf 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -47,7 +47,7 @@ Vetting an idea publicly before going as far as writing an EIP is meant to save Once the champion has asked the Ethereum community whether an idea has any chance of acceptance a draft EIP should be presented as a [pull request]. -If the EIP editors accept the EIP as a draft ([see the EIP editors workflow section below for details](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-editor-responsibilities-and-workflow)) and the authors are happy for it to be merged as a draft, the EIP editor will assign the EIP a number (generally the issue or PR number related to the EIP) and merge your pull request. The EIP editor will not unreasonably deny an EIP. Reasons for denying EIP status include duplication of effort, being technically unsound, not providing proper motivation or addressing backwards compatibility, or not in keeping with the [Ethereum philosophy](https://github.com/ethereum/wiki/wiki/White-Paper#philosophy). +EIP authors can request for the pull request to be merged as Draft when significant progress is made. Remember, Drafts can always be edited after merging. If the EIP editors accept the EIP as a draft ([see the EIP editors workflow section below for details](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-editor-responsibilities-and-workflow)), the EIP editor will assign the EIP a number (generally the issue or PR number related to the EIP) and merge your pull request. The EIP editor will not unreasonably deny an EIP. Reasons for denying EIP status include duplication of effort, being technically unsound, not providing proper motivation or addressing backwards compatibility, or not in keeping with the [Ethereum philosophy](https://github.com/ethereum/wiki/wiki/White-Paper#philosophy). Once the first draft has been merged, you may submit follow-up pull requests with further changes to your draft until such point as you believe the EIP to be mature and ready to proceed to the next phase. From 58d22b49110b492990e6303f91bcbeba9c430c4d Mon Sep 17 00:00:00 2001 From: William Entriken Date: Thu, 24 May 2018 22:52:04 -0400 Subject: [PATCH 06/25] Add accepted as draft --- EIPS/eip-1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 7675da18c85bf..dbea9aeaf3da2 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -51,7 +51,7 @@ EIP authors can request for the pull request to be merged as Draft when signific Once the first draft has been merged, you may submit follow-up pull requests with further changes to your draft until such point as you believe the EIP to be mature and ready to proceed to the next phase. -Standards Track EIPs consist of three parts, a design document, implementation, and finally if warranted an update to the [formal specification]. Standards Track Core EIPs must be implemented in at least three viable Ethereum clients before it can be considered Final. +Standards Track EIPs consist of three parts, a design document, implementation, and finally if warranted an update to the [formal specification]. The EIP should be reviewed and accepted as Draft before an implementation is begun, unless an implementation will aid people in studying the EIP. Standards Track Core EIPs must be implemented in at least three viable Ethereum clients before it can be considered Final. For an EIP to be accepted it must meet certain minimum criteria. It must be a clear and complete description of the proposed enhancement. The enhancement must represent a net improvement. The proposed implementation, if applicable, must be solid and must not complicate the protocol unduly. From 9c0b7b58f0fd48fc51f74d77e7ec609ad92a22c8 Mon Sep 17 00:00:00 2001 From: William Entriken Date: Thu, 24 May 2018 23:00:38 -0400 Subject: [PATCH 07/25] Match statuses to words used in text --- EIPS/eip-1.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index dbea9aeaf3da2..11d64b2964cab 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -59,7 +59,7 @@ An EIP in draft status must have implementations to be considered for promotion Standards track EIPs of type "Core" that pass "Last Call" will be sent to the core devs meeting for review. A successful review will lead to "Accepted" status. And when implemented in at least two clients totalling at least 50% of deployed nodes, and all pass a common set of test suites, the status of the EIP is updated to "Final". Alternatively, non-core EIPS will proceed directly from "Last Call" to "Final". -Other exceptional outcomes for EIPS include "deferred", a temporary status for drafts which have no recent progress, and "rejected" which records an EIP that is fundamentally broken and will not be implemented. Also, "active" denotes an EIP that is in effect but which may be updated without changing its EIP number. A "final" EIP should be updated on to correct errata, although another EIP may wish to supercede it — in that case you would have an original and succesor EIP both in final status. +Other exceptional outcomes for EIPS include "deferred", a temporary status for drafts which have no recent progress, and "rejected" which records an EIP that is fundamentally broken and will not be implemented. Also, "active" denotes an EIP that is in effect but which may be updated without changing its EIP number. A "final" EIP should be updated on to correct errata, although another EIP may wish to "supersede" it — in that case you would have an original and succesor EIP both in final status. ## What belongs in a successful EIP? @@ -93,7 +93,7 @@ Each EIP must begin with an RFC 822 style header preamble, preceded and followed ` * discussions-to:` -` status:` +` status:` `* review-period:`Starting YYYY-MM-DD, ending YYYY-MM-DD From 06eacee5308eec4fb1a61af928e6617b6f689d7d Mon Sep 17 00:00:00 2001 From: William Entriken Date: Thu, 24 May 2018 23:02:57 -0400 Subject: [PATCH 08/25] Match whitespace --- EIPS/eip-1.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 11d64b2964cab..315f00a378b74 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -93,9 +93,9 @@ Each EIP must begin with an RFC 822 style header preamble, preceded and followed ` * discussions-to:` -` status:` +` status:` -`* review-period:`Starting YYYY-MM-DD, ending YYYY-MM-DD +`* review-period:` Starting YYYY-MM-DD, ending YYYY-MM-DD ` type: ` From d0735df0a671d563b05058ff52528ca6a198997a Mon Sep 17 00:00:00 2001 From: William Entriken Date: Fri, 25 May 2018 14:15:29 -0400 Subject: [PATCH 09/25] Add last call RSS --- _data/statuses.yaml | 1 + index.html | 5 ++++- last-call.xml | 22 ++++++++++++++++++++++ 3 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 last-call.xml diff --git a/_data/statuses.yaml b/_data/statuses.yaml index c8b18a8730ffc..b5bad47beb3a2 100644 --- a/_data/statuses.yaml +++ b/_data/statuses.yaml @@ -1,3 +1,4 @@ +- Last Call - Draft - Accepted - Final diff --git a/index.html b/index.html index 1f88bdc1c65bb..1a10ea848e959 100644 --- a/index.html +++ b/index.html @@ -3,7 +3,10 @@ title: Home --- -

EIPs Gitter

+

EIPs + Gitter + RSS +

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

Contributing

diff --git a/last-call.xml b/last-call.xml new file mode 100644 index 0000000000000..1cef04d591ca3 --- /dev/null +++ b/last-call.xml @@ -0,0 +1,22 @@ +--- +layout: null +--- + + + + Ethereum EIPs Last Call Review + All EIPs which are in the two-week "last call" status, please help review these and provid your feedback! + {{ site.url }} + + {% assign eips = site.pages|where:"status","Last Call"|sort:"eip" %} + {% for page in eips %} + + {{ page.title | xml_escape }} + {{ page.content | xml_escape }} + {{ page.date | date: "%a, %d %b %Y %H:%M:%S %z" }} + {{ site.url }}/{{ page.url }} + {{ site.url }}/{{ page.url }} + + {% endfor %} + + From bb45b6a0fcec7b9758209e646ffe6e9ee3ee72c4 Mon Sep 17 00:00:00 2001 From: William Entriken Date: Fri, 25 May 2018 14:18:36 -0400 Subject: [PATCH 10/25] add RSS link to EIP1 --- EIPS/eip-1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 315f00a378b74..a1ed095979962 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -55,7 +55,7 @@ Standards Track EIPs consist of three parts, a design document, implementation, For an EIP to be accepted it must meet certain minimum criteria. It must be a clear and complete description of the proposed enhancement. The enhancement must represent a net improvement. The proposed implementation, if applicable, must be solid and must not complicate the protocol unduly. -An EIP in draft status must have implementations to be considered for promotion to the next status. When no further changes are planned and adove rules are met, the champion will request, and the editor will approve a change to "Last Call" status. This EIP will listed prominently on the http://eips.ethereum.org/ website (subscribe via RSS here [TODO LATER, ADD A LINK HERE]). After the review period, if all issues are resolved, then the editor will proceed to the next status; if issues remain then it may be returned to draft. +An EIP in draft status must have implementations to be considered for promotion to the next status. When no further changes are planned and adove rules are met, the champion will request, and the editor will approve a change to "Last Call" status. This EIP will listed prominently on the http://eips.ethereum.org/ website (subscribe via RSS at [last-call.xml](/last-call.xml)). After the review period, if all issues are resolved, then the editor will proceed to the next status; if issues remain then it may be returned to draft. Standards track EIPs of type "Core" that pass "Last Call" will be sent to the core devs meeting for review. A successful review will lead to "Accepted" status. And when implemented in at least two clients totalling at least 50% of deployed nodes, and all pass a common set of test suites, the status of the EIP is updated to "Final". Alternatively, non-core EIPS will proceed directly from "Last Call" to "Final". From 50ae6aca84447c411195dc45d489d2c2f4c0af65 Mon Sep 17 00:00:00 2001 From: William Entriken Date: Fri, 25 May 2018 14:22:31 -0400 Subject: [PATCH 11/25] Update deferred wording --- EIPS/eip-1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index a1ed095979962..ed1caaa16b357 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -59,7 +59,7 @@ An EIP in draft status must have implementations to be considered for promotion Standards track EIPs of type "Core" that pass "Last Call" will be sent to the core devs meeting for review. A successful review will lead to "Accepted" status. And when implemented in at least two clients totalling at least 50% of deployed nodes, and all pass a common set of test suites, the status of the EIP is updated to "Final". Alternatively, non-core EIPS will proceed directly from "Last Call" to "Final". -Other exceptional outcomes for EIPS include "deferred", a temporary status for drafts which have no recent progress, and "rejected" which records an EIP that is fundamentally broken and will not be implemented. Also, "active" denotes an EIP that is in effect but which may be updated without changing its EIP number. A "final" EIP should be updated on to correct errata, although another EIP may wish to "supersede" it — in that case you would have an original and succesor EIP both in final status. +Other exceptional outcomes for EIPS include "deferred", when a core EIP is delayed for a future hard for, and "rejected" which records an EIP that is fundamentally broken and will not be implemented. Also, "active" denotes an EIP that is in effect but which may be updated without changing its EIP number. A "final" EIP should be updated on to correct errata, although another EIP may wish to "supersede" it — in that case you would have an original and succesor EIP both in final status. ## What belongs in a successful EIP? From 204b3ec1c5e327ba59e29d94841d3755976a4c7e Mon Sep 17 00:00:00 2001 From: William Entriken Date: Sun, 27 May 2018 10:48:22 -0400 Subject: [PATCH 12/25] Provide --- last-call.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/last-call.xml b/last-call.xml index 1cef04d591ca3..35baa92e4aab6 100644 --- a/last-call.xml +++ b/last-call.xml @@ -5,7 +5,7 @@ layout: null Ethereum EIPs Last Call Review - All EIPs which are in the two-week "last call" status, please help review these and provid your feedback! + All EIPs which are in the two-week "last call" status, please help review these and provide your feedback! {{ site.url }} {% assign eips = site.pages|where:"status","Last Call"|sort:"eip" %} From 321d8fe4128d3a5b4d7618f7ab097bd3ead5c7bf Mon Sep 17 00:00:00 2001 From: William Entriken Date: Sun, 27 May 2018 10:51:36 -0400 Subject: [PATCH 13/25] "EIP authors can request" --- EIPS/eip-1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index ed1caaa16b357..ccda253318355 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -47,7 +47,7 @@ Vetting an idea publicly before going as far as writing an EIP is meant to save Once the champion has asked the Ethereum community whether an idea has any chance of acceptance a draft EIP should be presented as a [pull request]. -EIP authors can request for the pull request to be merged as Draft when significant progress is made. Remember, Drafts can always be edited after merging. If the EIP editors accept the EIP as a draft ([see the EIP editors workflow section below for details](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-editor-responsibilities-and-workflow)), the EIP editor will assign the EIP a number (generally the issue or PR number related to the EIP) and merge your pull request. The EIP editor will not unreasonably deny an EIP. Reasons for denying EIP status include duplication of effort, being technically unsound, not providing proper motivation or addressing backwards compatibility, or not in keeping with the [Ethereum philosophy](https://github.com/ethereum/wiki/wiki/White-Paper#philosophy). +EIP authors can request for the pull request to be merged as Draft. Then, if the EIP editors approve the EIP ([see the EIP editors workflow section below for details](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-editor-responsibilities-and-workflow)), the EIP editor will assign the EIP a number (generally the issue or PR number related to the EIP) and merge your pull request. The EIP editor will not unreasonably deny an EIP. Reasons for denying EIP status include duplication of effort, being technically unsound, not providing proper motivation or addressing backwards compatibility, or not in keeping with the [Ethereum philosophy](https://github.com/ethereum/wiki/wiki/White-Paper#philosophy). Once the first draft has been merged, you may submit follow-up pull requests with further changes to your draft until such point as you believe the EIP to be mature and ready to proceed to the next phase. From f6a321c9782995ca067132699aa5be5c2d56f641 Mon Sep 17 00:00:00 2001 From: William Entriken Date: Sun, 27 May 2018 11:01:24 -0400 Subject: [PATCH 14/25] Correct HTML error --- index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.html b/index.html index 1a10ea848e959..8eb533ad42b8f 100644 --- a/index.html +++ b/index.html @@ -4,7 +4,7 @@ ---

EIPs - Gitter + Gitter RSS

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

From 0ebde39dbfe832dcc2926b5bc85c8a5bbebd0144 Mon Sep 17 00:00:00 2001 From: William Entriken Date: Mon, 28 May 2018 15:28:36 -0400 Subject: [PATCH 15/25] review-period last date only --- EIPS/eip-1.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index ccda253318355..c30616d78ecee 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -55,7 +55,7 @@ Standards Track EIPs consist of three parts, a design document, implementation, For an EIP to be accepted it must meet certain minimum criteria. It must be a clear and complete description of the proposed enhancement. The enhancement must represent a net improvement. The proposed implementation, if applicable, must be solid and must not complicate the protocol unduly. -An EIP in draft status must have implementations to be considered for promotion to the next status. When no further changes are planned and adove rules are met, the champion will request, and the editor will approve a change to "Last Call" status. This EIP will listed prominently on the http://eips.ethereum.org/ website (subscribe via RSS at [last-call.xml](/last-call.xml)). After the review period, if all issues are resolved, then the editor will proceed to the next status; if issues remain then it may be returned to draft. +An EIP in draft status must have implementations to be considered for promotion to the next status. When no further changes are planned and adove rules are met, the champion will request, and the editor will approve a change to "Last Call" status and set the review date (normally the date of the change plus 14 days). This EIP will listed prominently on the http://eips.ethereum.org/ website (subscribe via RSS at [last-call.xml](/last-call.xml)). After the review period, if all issues are resolved, then the editor will proceed to the next status; if issues remain then it may be returned to draft. Standards track EIPs of type "Core" that pass "Last Call" will be sent to the core devs meeting for review. A successful review will lead to "Accepted" status. And when implemented in at least two clients totalling at least 50% of deployed nodes, and all pass a common set of test suites, the status of the EIP is updated to "Final". Alternatively, non-core EIPS will proceed directly from "Last Call" to "Final". @@ -95,7 +95,7 @@ Each EIP must begin with an RFC 822 style header preamble, preceded and followed ` status:` -`* review-period:` Starting YYYY-MM-DD, ending YYYY-MM-DD +`* review-period-end-date: YYYY-MM-DD ` type: ` From 46e54b250b30c7080b99ed2cb6e09208becabaec Mon Sep 17 00:00:00 2001 From: William Entriken Date: Mon, 28 May 2018 15:36:01 -0400 Subject: [PATCH 16/25] Briefer review end date name --- EIPS/eip-1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index c30616d78ecee..30f8c4f4db50d 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -95,7 +95,7 @@ Each EIP must begin with an RFC 822 style header preamble, preceded and followed ` status:` -`* review-period-end-date: YYYY-MM-DD +`* review-period-end: YYYY-MM-DD ` type: ` From 03aab50a55547e72d1a52ff967bac13b3ad53a39 Mon Sep 17 00:00:00 2001 From: William Entriken Date: Tue, 29 May 2018 18:02:11 -0400 Subject: [PATCH 17/25] alse --- EIPS/eip-1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 30f8c4f4db50d..3b06b47808cb4 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -37,7 +37,7 @@ The normal process is: [ A pull request ] -> [ DRAFT ] -> [ LAST CALL ] -> [APPROVED] -> [ FINAL ] ``` -The [EIP editors](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-editors) update the status of EIPs at the request of EIP authors. Please ping the editors by mentioning them in your pull request or send them an email. See alse [EIP Editor Responsibilities & Workflow](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-editor-responsibilities-and-workflow). +The [EIP editors](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-editors) update the status of EIPs at the request of EIP authors. Please ping the editors by mentioning them in your pull request or send them an email. See also [EIP Editor Responsibilities & Workflow](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-editor-responsibilities-and-workflow). The EIP process begins with a new idea for Ethereum. It is highly recommended that a single EIP contain a single key proposal or new idea. The more focused the EIP, the more successful it tends to be. A change to one client doesn't require an EIP; a change that affects multiple clients, or defines a standard for multiple apps to use, does. The EIP editor reserves the right to reject EIP proposals if they appear too unfocused or too broad. If in doubt, split your EIP into several well-focused ones. From efa96f21af792d1790556c5150778bc60c152376 Mon Sep 17 00:00:00 2001 From: William Entriken Date: Tue, 29 May 2018 19:06:41 -0400 Subject: [PATCH 18/25] Fully document statuses and transitions --- EIPS/eip-1.md | 61 +++++++++++++++++++++++++++++---------------------- 1 file changed, 35 insertions(+), 26 deletions(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 3b06b47808cb4..6e59bd0a49bfa 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -21,7 +21,7 @@ For Ethereum implementers, EIPs are a convenient way to track the progress of th There are three types of EIP: -- A **Standard Track EIP** describes any change that affects most or all Ethereum implementations, such as a change to the the network protocol, a change in block or transaction validity rules, proposed application standards/conventions, or any change or addition that affects the interoperability of applications using Ethereum. Furthermore Standard EIPs can be broken down into the following categories. +- A **Standard Track EIP** describes any change that affects most or all Ethereum implementations, such as a change to the the network protocol, a change in block or transaction validity rules, proposed application standards/conventions, or any change or addition that affects the interoperability of applications using Ethereum. Furthermore Standard EIPs can be broken down into the following categories. Standards Track EIPs consist of three parts, a design document, implementation, and finally if warranted an update to the [formal specification]. - **Core** - improvements requiring a consensus fork (e.g. [EIP5], [EIP101]), as well as changes that are not necessarily consensus critical but may be relevant to [“core dev” discussions](https://github.com/ethereum/pm) (for example, [EIP90], and the miner/node strategy changes 2, 3, and 4 of [EIP86]). - **Networking** - includes improvements around [devp2p] ([EIP8]) and [Light Ethereum Subprotocol], as well as proposed improvements to network protocol specifications of [whisper] and [swarm]. - **Interface** - includes improvements around client [API/RPC] specifications and standards, and also certain language-level standards like method names ([EIP59], [EIP6]) and [contract ABIs]. The label “interface” aligns with the [interfaces repo] and discussion should primarily occur in that repository before an EIP is submitted to the EIPs repository. @@ -29,37 +29,44 @@ There are three types of EIP: - An **Informational EIP** describes an Ethereum design issue, or provides general guidelines or information to the Ethereum community, but does not propose a new feature. Informational EIPs do not necessarily represent Ethereum community consensus or a recommendation, so users and implementers are free to ignore Informational EIPs or follow their advice. - A **Meta EIP** describes a process surrounding Ethereum or proposes a change to (or an event in) a process. Process EIPs are like Standards Track EIPs but apply to areas other than the Ethereum protocol itself. They may propose an implementation, but not to Ethereum's codebase; they often require community consensus; unlike Informational EIPs, they are more than recommendations, and users are typically not free to ignore them. Examples include procedures, guidelines, changes to the decision-making process, and changes to the tools or environment used in Ethereum development. Any meta-EIP is also considered a Process EIP. -## EIP Work Flow - -The normal process is: - -``` -[ A pull request ] -> [ DRAFT ] -> [ LAST CALL ] -> [APPROVED] -> [ FINAL ] -``` - -The [EIP editors](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-editors) update the status of EIPs at the request of EIP authors. Please ping the editors by mentioning them in your pull request or send them an email. See also [EIP Editor Responsibilities & Workflow](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-editor-responsibilities-and-workflow). - -The EIP process begins with a new idea for Ethereum. It is highly recommended that a single EIP contain a single key proposal or new idea. The more focused the EIP, the more successful it tends to be. A change to one client doesn't require an EIP; a change that affects multiple clients, or defines a standard for multiple apps to use, does. The EIP editor reserves the right to reject EIP proposals if they appear too unfocused or too broad. If in doubt, split your EIP into several well-focused ones. +It is highly recommended that a single EIP contain a single key proposal or new idea. The more focused the EIP, the more successful it tends to be. A change to one client doesn't require an EIP; a change that affects multiple clients, or defines a standard for multiple apps to use, does. -Each EIP must have a champion—someone who writes the EIP using the style and format described below, shepherds the discussions in the appropriate forums, and attempts to build community consensus around the idea. +An EIP must meet certain minimum criteria. It must be a clear and complete description of the proposed enhancement. The enhancement must represent a net improvement. The proposed implementation, if applicable, must be solid and must not complicate the protocol unduly. -Vetting an idea publicly before going as far as writing an EIP is meant to save the potential author time. Ask the Ethereum community first if an idea is original to avoid wasting time on something that will be be rejected based on prior research (searching the Internet does not always do the trick). It also helps to make sure the idea is applicable to the entire community and not just the author. Just because an idea sounds good to the author does not mean it will work for most people in most areas where Ethereum is used. Examples of appropriate public forums to gauge interest around your EIP include [the Ethereum subreddit], [the Issues section of this repository], and [one of the Ethereum Gitter chat rooms]. In particular, [the Issues section of this repository] is an excellent place to discuss your proposal with the community and start creating more formalized language around your EIP. - -Once the champion has asked the Ethereum community whether an idea has any chance of acceptance a draft EIP should be presented as a [pull request]. - -EIP authors can request for the pull request to be merged as Draft. Then, if the EIP editors approve the EIP ([see the EIP editors workflow section below for details](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-editor-responsibilities-and-workflow)), the EIP editor will assign the EIP a number (generally the issue or PR number related to the EIP) and merge your pull request. The EIP editor will not unreasonably deny an EIP. Reasons for denying EIP status include duplication of effort, being technically unsound, not providing proper motivation or addressing backwards compatibility, or not in keeping with the [Ethereum philosophy](https://github.com/ethereum/wiki/wiki/White-Paper#philosophy). - -Once the first draft has been merged, you may submit follow-up pull requests with further changes to your draft until such point as you believe the EIP to be mature and ready to proceed to the next phase. +## EIP Work Flow -Standards Track EIPs consist of three parts, a design document, implementation, and finally if warranted an update to the [formal specification]. The EIP should be reviewed and accepted as Draft before an implementation is begun, unless an implementation will aid people in studying the EIP. Standards Track Core EIPs must be implemented in at least three viable Ethereum clients before it can be considered Final. +Parties involved in the process are you, the champion or *EIP author*, the [*EIP editors*](#eip-editors), and the [*Ethereum Core Developers*](https://github.com/ethereum/pm). -For an EIP to be accepted it must meet certain minimum criteria. It must be a clear and complete description of the proposed enhancement. The enhancement must represent a net improvement. The proposed implementation, if applicable, must be solid and must not complicate the protocol unduly. +:warning: Before you begin, vet your idea, this will save you time. Ask the Ethereum community first if an idea is original to avoid wasting time on something that will be be rejected based on prior research (searching the Internet does not always do the trick). It also helps to make sure the idea is applicable to the entire community and not just the author. Just because an idea sounds good to the author does not mean it will work for most people in most areas where Ethereum is used. Examples of appropriate public forums to gauge interest around your EIP include [the Ethereum subreddit], [the Issues section of this repository], and [one of the Ethereum Gitter chat rooms]. In particular, [the Issues section of this repository] is an excellent place to discuss your proposal with the community and start creating more formalized language around your EIP. -An EIP in draft status must have implementations to be considered for promotion to the next status. When no further changes are planned and adove rules are met, the champion will request, and the editor will approve a change to "Last Call" status and set the review date (normally the date of the change plus 14 days). This EIP will listed prominently on the http://eips.ethereum.org/ website (subscribe via RSS at [last-call.xml](/last-call.xml)). After the review period, if all issues are resolved, then the editor will proceed to the next status; if issues remain then it may be returned to draft. +Your role as the champion is to write the EIP 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 EIP will move along: -Standards track EIPs of type "Core" that pass "Last Call" will be sent to the core devs meeting for review. A successful review will lead to "Accepted" status. And when implemented in at least two clients totalling at least 50% of deployed nodes, and all pass a common set of test suites, the status of the EIP is updated to "Final". Alternatively, non-core EIPS will proceed directly from "Last Call" to "Final". +``` +[ WIP ] -> [ DRAFT ] -> [ LAST CALL ] -> [ ACCEPTED ] -> [ FINAL ] +``` -Other exceptional outcomes for EIPS include "deferred", when a core EIP is delayed for a future hard for, and "rejected" which records an EIP that is fundamentally broken and will not be implemented. Also, "active" denotes an EIP that is in effect but which may be updated without changing its EIP number. A "final" EIP should be updated on to correct errata, although another EIP may wish to "supersede" it — in that case you would have an original and succesor EIP both in final status. +Each status change is requested by the EIP author by @-mentioning or emailing the EIP editors. The EIP editors will process these requests as per the conditions below. + +* **Work in progress (WIP)** -- Once the champion has asked the Ethereum community whether an idea has any chance of acceptance, they will write a draft EIP as a [pull request]. Consider including an implementation if this will aid people in studying the EIP. + * :arrow_right: Draft -- If approved, EIP editor will assign the EIP a number (generally the issue or PR number related to the EIP) and merge your pull request. The EIP editor will not unreasonably deny an EIP. + * :x: Draft -- Reasons for denying draft status include being too unfocused, too broad, duplication of effort, being technically unsound, not providing proper motivation or addressing backwards compatibility, or not in keeping with the [Ethereum philosophy](https://github.com/ethereum/wiki/wiki/White-Paper#philosophy). +* **Draft** -- Once the first draft has been merged, you may submit follow-up pull requests with further changes to your draft until such point as you believe the EIP to be mature and ready to proceed to the next status. An EIP in draft status must have implementations to be considered for promotion to the next status. + * :arrow_right: Last Call -- If approved, the EIP editor will assign Last Call status and set a review end date, normally 14 days later. + * :x: Last Call -- A request for Last Call status will be denied if material changes are still expected to be made to the draft. We hope that EIPs only enter Last Call once, so as to avoid unnecessary noise on the RSS feed. Last Call will be denied if the implementation is not complete and accepted by the community. +* **Last Call** -- This EIP will listed prominently on the http://eips.ethereum.org/ website (subscribe via RSS at [last-call.xml](/last-call.xml)). + * :x: -- A Last Call which results in material changes or substantial unaddressed complaints will cause the EIP to revert to Draft or worse. + * :arrow_right: Accepted (Core EIPs only) -- After the review end date, the Ethereum Core Developers will vote on whether to accept this change. If yes, the status will upgrade to Accepted. + * :arrow_right: Final (Not core EIPs) -- A successful Last Call without material changes or unaddressed complaints will become Final. +* **Accepted (Core EIPs only)** -- This is being implemented by Ethereum Core Developers. + * :arrow_right: Final -- When a Standards Track Core EIP is implemented in at least three viable Ethereum clients, and it is deployed on at least 50% of deployed nodes, and the implementations pass a common set of test suites, then the status is upgraded to Final. +* **Final** -- This EIP represents the current state-of-the-art. A Final EIP should only be updated to correct errata. + +Other exceptional statuses include: + +* Deferred -- This is for core EIPs that have been put off for a future hard fork. +* Rejected -- An EIP that is fundamentally broken and will not be implemented. +* Active -- This is similar to Final, but denotes an EIP which which may be updated without changing its EIP number. +* Superseded -- An EIP which was previously final but is no longer considered state-of-the-art. Another EIP will be in Final status and reference the Superseded EIP. ## What belongs in a successful EIP? @@ -169,7 +176,7 @@ The current EIP editors are ` * Martin Becze (@wanderer)` -## EIP Editor Responsibilities and Workflow +## EIP Editor Responsibilities For each new EIP that comes in, an editor does the following: @@ -201,6 +208,8 @@ February 1, 2016: EIP 1 has added editors, made draft improvements to process, a March 21, 2018: Minor edits to accommodate the new automatically-generated EIP directory on [eips.ethereum.org](http://eips.ethereum.org/). +May 29, 2018: A last call process was added. + See [the revision history for further details](https://github.com/ethereum/EIPs/commits/master/EIPS/eip-1.md), which is also available by clicking on the History button in the top right of the EIP. ### Bibliography From 779c13a191b7965070b8836ee5b68ec7f4c7cf2b Mon Sep 17 00:00:00 2001 From: William Entriken Date: Wed, 30 May 2018 10:19:10 -0400 Subject: [PATCH 19/25] One implementation for draft --- EIPS/eip-1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 6e59bd0a49bfa..8d34fa91b5dc2 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -50,7 +50,7 @@ Each status change is requested by the EIP author by @-mentioning or emailing th * **Work in progress (WIP)** -- Once the champion has asked the Ethereum community whether an idea has any chance of acceptance, they will write a draft EIP as a [pull request]. Consider including an implementation if this will aid people in studying the EIP. * :arrow_right: Draft -- If approved, EIP editor will assign the EIP a number (generally the issue or PR number related to the EIP) and merge your pull request. The EIP editor will not unreasonably deny an EIP. * :x: Draft -- Reasons for denying draft status include being too unfocused, too broad, duplication of effort, being technically unsound, not providing proper motivation or addressing backwards compatibility, or not in keeping with the [Ethereum philosophy](https://github.com/ethereum/wiki/wiki/White-Paper#philosophy). -* **Draft** -- Once the first draft has been merged, you may submit follow-up pull requests with further changes to your draft until such point as you believe the EIP to be mature and ready to proceed to the next status. An EIP in draft status must have implementations to be considered for promotion to the next status. +* **Draft** -- Once the first draft has been merged, you may submit follow-up pull requests with further changes to your draft until such point as you believe the EIP to be mature and ready to proceed to the next status. An EIP in draft status must be implemented to be considered for promotion to the next status (ignore this requirement for core EIPs). * :arrow_right: Last Call -- If approved, the EIP editor will assign Last Call status and set a review end date, normally 14 days later. * :x: Last Call -- A request for Last Call status will be denied if material changes are still expected to be made to the draft. We hope that EIPs only enter Last Call once, so as to avoid unnecessary noise on the RSS feed. Last Call will be denied if the implementation is not complete and accepted by the community. * **Last Call** -- This EIP will listed prominently on the http://eips.ethereum.org/ website (subscribe via RSS at [last-call.xml](/last-call.xml)). From 68e235da0d7217fa60fe7dc77565a9c6ef0ca6e7 Mon Sep 17 00:00:00 2001 From: William Entriken Date: Wed, 30 May 2018 10:20:06 -0400 Subject: [PATCH 20/25] Focus on the goal --- EIPS/eip-1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 8d34fa91b5dc2..a41f77cf654e3 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -54,7 +54,7 @@ Each status change is requested by the EIP author by @-mentioning or emailing th * :arrow_right: Last Call -- If approved, the EIP editor will assign Last Call status and set a review end date, normally 14 days later. * :x: Last Call -- A request for Last Call status will be denied if material changes are still expected to be made to the draft. We hope that EIPs only enter Last Call once, so as to avoid unnecessary noise on the RSS feed. Last Call will be denied if the implementation is not complete and accepted by the community. * **Last Call** -- This EIP will listed prominently on the http://eips.ethereum.org/ website (subscribe via RSS at [last-call.xml](/last-call.xml)). - * :x: -- A Last Call which results in material changes or substantial unaddressed complaints will cause the EIP to revert to Draft or worse. + * :x: -- A Last Call which results in material changes or substantial unaddressed complaints will cause the EIP to revert to Draft. * :arrow_right: Accepted (Core EIPs only) -- After the review end date, the Ethereum Core Developers will vote on whether to accept this change. If yes, the status will upgrade to Accepted. * :arrow_right: Final (Not core EIPs) -- A successful Last Call without material changes or unaddressed complaints will become Final. * **Accepted (Core EIPs only)** -- This is being implemented by Ethereum Core Developers. From fa34504ae9e7c1bb1c48af186aec327188fe1596 Mon Sep 17 00:00:00 2001 From: William Entriken Date: Wed, 30 May 2018 10:31:30 -0400 Subject: [PATCH 21/25] Use prior definition of final --- EIPS/eip-1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index a41f77cf654e3..97c6ef59ab088 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -58,7 +58,7 @@ Each status change is requested by the EIP author by @-mentioning or emailing th * :arrow_right: Accepted (Core EIPs only) -- After the review end date, the Ethereum Core Developers will vote on whether to accept this change. If yes, the status will upgrade to Accepted. * :arrow_right: Final (Not core EIPs) -- A successful Last Call without material changes or unaddressed complaints will become Final. * **Accepted (Core EIPs only)** -- This is being implemented by Ethereum Core Developers. - * :arrow_right: Final -- When a Standards Track Core EIP is implemented in at least three viable Ethereum clients, and it is deployed on at least 50% of deployed nodes, and the implementations pass a common set of test suites, then the status is upgraded to Final. + * :arrow_right: Final -- Standards Track Core EIPs must be implemented in at least three viable Ethereum clients before it can be considered Final. When the implementation is complete and accepted by the community, the status will be changed to “Final”. * **Final** -- This EIP represents the current state-of-the-art. A Final EIP should only be updated to correct errata. Other exceptional statuses include: From cef7d9d4c29bfb5df85ebc8d962cf6952448e4d6 Mon Sep 17 00:00:00 2001 From: William Entriken Date: Wed, 30 May 2018 10:41:23 -0400 Subject: [PATCH 22/25] Use Accepted --- EIPS/eip-1.md | 18 +++++++++--------- _data/statuses.yaml | 2 +- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 97c6ef59ab088..ead286fc35a5f 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -47,18 +47,18 @@ Your role as the champion is to write the EIP using the style and format describ Each status change is requested by the EIP author by @-mentioning or emailing the EIP editors. The EIP editors will process these requests as per the conditions below. -* **Work in progress (WIP)** -- Once the champion has asked the Ethereum community whether an idea has any chance of acceptance, they will write a draft EIP as a [pull request]. Consider including an implementation if this will aid people in studying the EIP. - * :arrow_right: Draft -- If approved, EIP editor will assign the EIP a number (generally the issue or PR number related to the EIP) and merge your pull request. The EIP editor will not unreasonably deny an EIP. +* **Work in progress (WIP)** -- Once the champion has asked the Ethereum community whether an idea has any chance of support, they will write a draft EIP as a [pull request]. Consider including an implementation if this will aid people in studying the EIP. + * :arrow_right: Draft -- If agreeable, EIP editor will assign the EIP a number (generally the issue or PR number related to the EIP) and merge your pull request. The EIP editor will not unreasonably deny an EIP. * :x: Draft -- Reasons for denying draft status include being too unfocused, too broad, duplication of effort, being technically unsound, not providing proper motivation or addressing backwards compatibility, or not in keeping with the [Ethereum philosophy](https://github.com/ethereum/wiki/wiki/White-Paper#philosophy). * **Draft** -- Once the first draft has been merged, you may submit follow-up pull requests with further changes to your draft until such point as you believe the EIP to be mature and ready to proceed to the next status. An EIP in draft status must be implemented to be considered for promotion to the next status (ignore this requirement for core EIPs). - * :arrow_right: Last Call -- If approved, the EIP editor will assign Last Call status and set a review end date, normally 14 days later. - * :x: Last Call -- A request for Last Call status will be denied if material changes are still expected to be made to the draft. We hope that EIPs only enter Last Call once, so as to avoid unnecessary noise on the RSS feed. Last Call will be denied if the implementation is not complete and accepted by the community. + * :arrow_right: Last Call -- If agreeable, the EIP editor will assign Last Call status and set a review end date, normally 14 days later. + * :x: Last Call -- A request for Last Call status will be denied if material changes are still expected to be made to the draft. We hope that EIPs only enter Last Call once, so as to avoid unnecessary noise on the RSS feed. Last Call will be denied if the implementation is not complete and supported by the community. * **Last Call** -- This EIP will listed prominently on the http://eips.ethereum.org/ website (subscribe via RSS at [last-call.xml](/last-call.xml)). * :x: -- A Last Call which results in material changes or substantial unaddressed complaints will cause the EIP to revert to Draft. * :arrow_right: Accepted (Core EIPs only) -- After the review end date, the Ethereum Core Developers will vote on whether to accept this change. If yes, the status will upgrade to Accepted. * :arrow_right: Final (Not core EIPs) -- A successful Last Call without material changes or unaddressed complaints will become Final. * **Accepted (Core EIPs only)** -- This is being implemented by Ethereum Core Developers. - * :arrow_right: Final -- Standards Track Core EIPs must be implemented in at least three viable Ethereum clients before it can be considered Final. When the implementation is complete and accepted by the community, the status will be changed to “Final”. + * :arrow_right: Final -- Standards Track Core EIPs must be implemented in at least three viable Ethereum clients before it can be considered Final. When the implementation is complete and supported by the community, the status will be changed to “Final”. * **Final** -- This EIP represents the current state-of-the-art. A Final EIP should only be updated to correct errata. Other exceptional statuses include: @@ -80,7 +80,7 @@ Each EIP should have the following parts: - 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. - Backwards Compatibility - All EIPs that introduce backwards incompatibilities must include a section describing these incompatibilities and their severity. The EIP must explain how the author proposes to deal with these incompatibilities. EIP submissions without a sufficient backwards compatibility treatise may be rejected outright. - Test Cases - Test cases for an implementation are mandatory for EIPs that are affecting consensus changes. Other EIPs can choose to include links to test cases if applicable. -- Implementations - The implementations must be completed before any EIP is given status “Final”, but it need not be completed before the EIP is accepted. While there is merit to the approach of reaching consensus on the specification and rationale before writing code, the principle of “rough consensus and running code” is still useful when it comes to resolving many discussions of API details. +- Implementations - The implementations must be completed before any EIP is given status “Final”, but it need not be completed before the EIP is merged as draft. While there is merit to the approach of reaching consensus on the specification and rationale before writing code, the principle of “rough consensus and running code” is still useful when it comes to resolving many discussions of API details. - Copyright Waiver - All EIPs must be in the public domain. See the bottom of this EIP for an example copyright waiver. ## EIP Formats and Templates @@ -100,7 +100,7 @@ Each EIP must begin with an RFC 822 style header preamble, preceded and followed ` * discussions-to:` -` status:` +` status:` `* review-period-end: YYYY-MM-DD @@ -180,7 +180,7 @@ The current EIP editors are For each new EIP that comes in, an editor does the following: -- Read the EIP to check if it is ready: sound and complete. The ideas must make technical sense, even if they don't seem likely to be accepted. +- Read the EIP 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 EIP for language (spelling, grammar, sentence structure, etc.), markup (Github flavored Markdown), code style @@ -190,7 +190,7 @@ Once the EIP is ready for the repository, the EIP editor will: - Assign an EIP 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 EIP) -- Accept the corresponding pull request +- Merge the corresponding pull request - Send a message back to the EIP author with the next step. diff --git a/_data/statuses.yaml b/_data/statuses.yaml index b5bad47beb3a2..228b7a4aca9fb 100644 --- a/_data/statuses.yaml +++ b/_data/statuses.yaml @@ -1,6 +1,6 @@ - Last Call - Draft -- Accepted +- Approved - Final - Active - Deferred From 289c9a3a4baf2eda607eba40195da38c4b693d0b Mon Sep 17 00:00:00 2001 From: William Entriken Date: Wed, 30 May 2018 10:55:12 -0400 Subject: [PATCH 23/25] Use Accepted --- _data/statuses.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_data/statuses.yaml b/_data/statuses.yaml index 228b7a4aca9fb..b5bad47beb3a2 100644 --- a/_data/statuses.yaml +++ b/_data/statuses.yaml @@ -1,6 +1,6 @@ - Last Call - Draft -- Approved +- Accepted - Final - Active - Deferred From 98cb10d8fd551fe506afb7329f93f4d348184b8a Mon Sep 17 00:00:00 2001 From: William Entriken Date: Wed, 30 May 2018 11:11:02 -0400 Subject: [PATCH 24/25] PR is the preferred mechanism to request status changes --- EIPS/eip-1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index ead286fc35a5f..6cfeadb19fa63 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -45,7 +45,7 @@ Your role as the champion is to write the EIP using the style and format describ [ WIP ] -> [ DRAFT ] -> [ LAST CALL ] -> [ ACCEPTED ] -> [ FINAL ] ``` -Each status change is requested by the EIP author by @-mentioning or emailing the EIP editors. The EIP editors will process these requests as per the conditions below. +Each status change is requested by the EIP author and reviewed by the EIP editors. Use a pull request to update the status. Please include a link to where people should continue discussing your EIP. The EIP editors will process these requests as per the conditions below. * **Work in progress (WIP)** -- Once the champion has asked the Ethereum community whether an idea has any chance of support, they will write a draft EIP as a [pull request]. Consider including an implementation if this will aid people in studying the EIP. * :arrow_right: Draft -- If agreeable, EIP editor will assign the EIP a number (generally the issue or PR number related to the EIP) and merge your pull request. The EIP editor will not unreasonably deny an EIP. From 3dd4b31253e35a95e64beadc880d5f7cb9e04ee2 Mon Sep 17 00:00:00 2001 From: William Entriken Date: Thu, 31 May 2018 23:57:23 -0400 Subject: [PATCH 25/25] hide markdown formatting --- EIPS/eip-1.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 6cfeadb19fa63..62501b03949d1 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -3,7 +3,8 @@ eip: 1 title: EIP Purpose and Guidelines status: Active type: Meta -author: Martin Becze , Hudson Jameson , [and others](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md). +author: Martin Becze , Hudson Jameson , and others + https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md created: 2015-10-27, 2017-02-01 ---