forked from ethereum/EIPs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
EIP-5069: EIP editor handbook in EIP form (ethereum#5069)
- Loading branch information
Showing
3 changed files
with
81 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
--- | ||
eip: 5069 | ||
title: EIP Editor Handbook | ||
description: Handy reference for EIP editors and those who want to become one | ||
author: Pooja Ranjan (@poojaranjan), Pandapip1 (@Pandapip1) | ||
discussions-to: https://ethereum-magicians.org/t/pr-5069-eip-editor-handbook/9137 | ||
status: Living | ||
type: Informational | ||
created: 2022-05-02 | ||
requires: 1 | ||
--- | ||
|
||
## Abstract | ||
An Ethereum Improvement Proposal (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 standardization process is a mechanism for proposing new features, for collecting community technical input on an issue, and for documenting the design decisions that have gone into Ethereum. Because improvement proposals are key components of Ethereum blockchain, it is important that they are well reviewed before reaching `Final` status. EIPs are stored in text files in a versioned repository which is monitored by the EIP editors. | ||
|
||
This EIP describes the recommended process for becoming an EIP editor. | ||
|
||
## Specification | ||
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119. | ||
|
||
### Application and Onboarding Process | ||
Anyone having a good understanding of the EIP standardization and network upgrade process, intermediate level experience on the core and/or application side of the Ethereum blockchain, and willingness to contribute to the process management MAY apply to become an EIP editor. Potential EIP editors SHOULD have the following skills: | ||
- Good communication skills | ||
- Ability to handle contentious discourse | ||
- 1-5 spare hours per week | ||
|
||
The best available resource to understand the EIP process is [EIP-1](./eip-1.md). Anyone desirous of becoming an EIP editor MUST understand this document. Afterwards, participating in the EIP process by commenting on and suggesting improvements to PRs and issues will familliarize the procedure, and is RECOMMENDED. The contributions of newer editors SHALL be monitored by other EIP editors. | ||
|
||
Anyone meeting the above requirements MAY make a pull request adding themselves as an EIP editor and adding themselves to the editor list in [EIP-1](./eip-1.md). If the existing EIP editors approve, the author SHALL become a full EIP editor. This SHALL notify the editor of relevant new proposals submitted in the EIPs repository, and they SHALL review and merge pull requests: | ||
|
||
```diff | ||
diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md | ||
index 79558a3..079b196 100644 | ||
--- a/EIPS/eip-1.md | ||
+++ b/EIPS/eip-1.md | ||
@@ -207,6 +211,7 @@ The current EIP editors are | ||
- Matt Garnett (@lightclient) | ||
- Micah Zoltu (@MicahZoltu) | ||
- Greg Colvin (@gcolvin) | ||
+- Sam Wilson (@SamWilsn) | ||
|
||
Emeritus EIP editors are | ||
|
||
diff --git a/.github/workflows/auto-merge-bot.yml b/.github/workflows/auto-merge-bot.yml | ||
index 5730343..3d162ea 100644 | ||
--- a/.github/workflows/auto-merge-bot.yml | ||
+++ b/.github/workflows/auto-merge-bot.yml | ||
@@ -17,12 +17,12 @@ jobs: | ||
id: auto-merge-bot | ||
with: | ||
GITHUB-TOKEN: ${{ secrets.TOKEN }} | ||
- CORE_EDITORS: "@MicahZoltu,@lightclient,@axic,@gcolvin" | ||
- ERC_EDITORS: "@lightclient,@axic" | ||
- NETWORKING_EDITORS: "@MicahZoltu,@lightclient,@axic" | ||
- INTERFACE_EDITORS: "@lightclient,@axic" | ||
- META_EDITORS: "@lightclient,@axic,@gcolvin" | ||
- INFORMATIONAL_EDITORS: "@lightclient,@axic,@gcolvin" | ||
+ CORE_EDITORS: "@MicahZoltu,@lightclient,@axic,@gcolvin,@SamWilsn" | ||
+ ERC_EDITORS: "@lightclient,@axic,@SamWilsn" | ||
+ NETWORKING_EDITORS: "@MicahZoltu,@lightclient,@axic,@SamWilsn" | ||
+ INTERFACE_EDITORS: "@lightclient,@axic,@SamWilsn" | ||
+ META_EDITORS: "@lightclient,@axic,@gcolvin,@SamWilsn" | ||
+ INFORMATIONAL_EDITORS: "@lightclient,@axic,@gcolvin,@SamWilsn" | ||
MAINTAINERS: "@alita-moore,@mryalamanchi" | ||
enable-auto-merge: | ||
if: github.repository == 'ethereum/eips' | ||
``` | ||
|
||
### Special Merging Rules for this EIP | ||
This EIP MUST have the same rules regarding changes as [EIP-1](./eip-1.md). | ||
|
||
## Rationale | ||
- "6 months" was chosen as the cutoff for denoting `Stagnant` EIPs terminally-`Stagnant` arbitrarily. | ||
- This EIP requires special merging rules for the same reason [EIP-1](./eip-1.md) does. | ||
|
||
## Copyright | ||
Copyright and related rights waived via [CC0](../LICENSE.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters