From 6fd09eeced9b607f21fa59d64421ac7acca5fba2 Mon Sep 17 00:00:00 2001 From: Gavin John Date: Mon, 24 Jul 2023 11:00:21 -0500 Subject: [PATCH 1/5] Update EIP-1: Add numbering guidelines --- EIPS/eip-1.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index e55c0351830a1..252daeac7e1f2 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -118,7 +118,7 @@ EIPs should be written in [markdown](https://github.com/adam-p/markdown-here/wik Each EIP must begin with an [RFC 822](https://www.ietf.org/rfc/rfc822.txt) style header preamble, preceded and followed by three hyphens (`---`). This header is also termed ["front matter" by Jekyll](https://jekyllrb.com/docs/front-matter/). The headers must appear in the following order. -`eip`: *EIP number* (this is determined by the EIP editor) +`eip`: *EIP number* `title`: *The EIP title is a few words, not a complete sentence* @@ -146,6 +146,17 @@ 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). +### `eip` header + +There are a few paths to receiving an EIP number: + +* The bot may automatically assign a temporary mnemonic while the EIP is still a PR. Before the PR is merged, an EIP number may be assigned by the bot. +* EIP editors can manually assign EIP numbers sequentially. +* With the approval of half of all governing EIP editors (rounded up), any EIP number can be assigned. + * If the EIP fixes an existing Final EIP, only one EIP editor (governing or non-governing) is needed to assign an EIP number. + +If more than one EIP number is assigned, authors may pick any assigned EIP number. If the EIP number assignment is subsequently retracted by any governing EIP editor or the editor that assigned the number, the EIP may not use that number anymore. The only remaining EIP number cannot be retracted; a new one must be assigned first. + ### `author` header The `author` header 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: @@ -451,7 +462,7 @@ If the EIP isn't ready, the editor will send it back to the author for revision, Once the EIP is ready for the repository, the EIP editor will: -- Assign an EIP number (generally the PR number, but the decision is with the editors) +- Assign an EIP number - Merge the corresponding [pull request](https://github.com/ethereum/EIPs/pulls) - Send a message back to the EIP author with the next step. From d46b89088f03a0f5f481d3a0b7446aff58f8e56c Mon Sep 17 00:00:00 2001 From: Gavin John Date: Mon, 24 Jul 2023 11:01:45 -0500 Subject: [PATCH 2/5] Switch from * to - --- EIPS/eip-1.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 252daeac7e1f2..fa7d54a9a0d54 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -150,10 +150,10 @@ Headers requiring dates will always do so in the format of ISO 8601 (yyyy-mm-dd) There are a few paths to receiving an EIP number: -* The bot may automatically assign a temporary mnemonic while the EIP is still a PR. Before the PR is merged, an EIP number may be assigned by the bot. -* EIP editors can manually assign EIP numbers sequentially. -* With the approval of half of all governing EIP editors (rounded up), any EIP number can be assigned. - * If the EIP fixes an existing Final EIP, only one EIP editor (governing or non-governing) is needed to assign an EIP number. +- The bot may automatically assign a temporary mnemonic while the EIP is still a PR. Before the PR is merged, an EIP number may be assigned by the bot. +- EIP editors can manually assign EIP numbers sequentially. +- With the approval of half of all governing EIP editors (rounded up), any EIP number can be assigned. + - If the EIP fixes an existing Final EIP, only one EIP editor (governing or non-governing) is needed to assign an EIP number. If more than one EIP number is assigned, authors may pick any assigned EIP number. If the EIP number assignment is subsequently retracted by any governing EIP editor or the editor that assigned the number, the EIP may not use that number anymore. The only remaining EIP number cannot be retracted; a new one must be assigned first. From 637573f410791145e044ab45181fb76075b26618 Mon Sep 17 00:00:00 2001 From: Gavin John Date: Sat, 29 Jul 2023 19:16:38 -0500 Subject: [PATCH 3/5] Update to new 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 fa7d54a9a0d54..ecc70881f0d10 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -462,7 +462,7 @@ If the EIP isn't ready, the editor will send it back to the author for revision, Once the EIP is ready for the repository, the EIP editor will: -- Assign an EIP number +- Assign an EIP number (generally incremental; editors can reassign if number sniping is suspected) - Merge the corresponding [pull request](https://github.com/ethereum/EIPs/pulls) - Send a message back to the EIP author with the next step. From f61ce8e5ba019d40e54173d8cf752bce9c3ff1c1 Mon Sep 17 00:00:00 2001 From: Gavin John Date: Sat, 29 Jul 2023 19:17:16 -0500 Subject: [PATCH 4/5] Remove other stuff --- EIPS/eip-1.md | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index ecc70881f0d10..6438864bfb36b 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -146,16 +146,6 @@ 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). -### `eip` header - -There are a few paths to receiving an EIP number: - -- The bot may automatically assign a temporary mnemonic while the EIP is still a PR. Before the PR is merged, an EIP number may be assigned by the bot. -- EIP editors can manually assign EIP numbers sequentially. -- With the approval of half of all governing EIP editors (rounded up), any EIP number can be assigned. - - If the EIP fixes an existing Final EIP, only one EIP editor (governing or non-governing) is needed to assign an EIP number. - -If more than one EIP number is assigned, authors may pick any assigned EIP number. If the EIP number assignment is subsequently retracted by any governing EIP editor or the editor that assigned the number, the EIP may not use that number anymore. The only remaining EIP number cannot be retracted; a new one must be assigned first. ### `author` header From 4ad706b23d75046bb86d56ac1bcd0db56385dbb9 Mon Sep 17 00:00:00 2001 From: Gavin John Date: Sat, 29 Jul 2023 19:17:33 -0500 Subject: [PATCH 5/5] Update EIPS/eip-1.md --- EIPS/eip-1.md | 1 - 1 file changed, 1 deletion(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 6438864bfb36b..b6a84f9d42099 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -146,7 +146,6 @@ 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). - ### `author` header The `author` header 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: