70 Commits

Author SHA1 Message Date
Alex Beregszaszi
1bfcf0c138
Add description field to the EIP header (#3706)
* Add description field to the EIP header

* Update 2718

* Move description rendering to below the title

* Remove the simple summary from the template

This has been removed from EIP-1 on 15-09-2019 in the PR https://github.com/ethereum/EIPs/pull/2186.

* Update title/description/abstract with new recommendation

* Mention length limit of description
2021-08-18 07:05:10 +08:00
Pooja Ranjan
9eae744e36
Update EIP template (#3719)
* Update EIP template

* Update eip-1.md

Updating EIP-1 to provide consistent information as the EIP template.
2021-08-15 19:17:46 +08:00
Pooja Ranjan
f0e228f976
Update EIP-1 (#3613)
* - Updated links - ACD, FEM

- Added EIP editor - Matt Garnett

- recommended to open a discussion thread at FEM (only recommended place)

* Update eip-1.md

add link to FEM & add EIP editor

* Update eip-1.md

* Update eip-1.md

* Update EIPS/eip-1.md

Co-authored-by: Micah Zoltu <micah@zoltu.net>

* Update eip-1.md

Removed a line "No `discussions-to` header is necessary if the EIP is being discussed privately with the author."

Co-authored-by: Alita Moore <alita.moore805@gmail.com>
Co-authored-by: Micah Zoltu <micah@zoltu.net>
2021-06-17 17:35:39 +08:00
Micah Zoltu
a9d9ec7938
Clarifies that test cases shouldn't be external links. (#3250)
We have been enforcing this for a while, I didn't realize EIP-1 said something different.
2021-03-07 06:52:52 +08:00
Varun Kashyap
f1ded2aa9b
Fixes some misspelled words, grammar and comprehension (#3296)
* Fixes some misspelled words, grammar and comprehension

- Replaces hyphen with colons where applicable
- Introduces em-dashes wherever necessary
- Fixes typos
- A better sentence structure for a few long sentences

* Update EIPS/eip-1.md

Co-authored-by: Micah Zoltu <micah@zoltu.net>

Co-authored-by: Micah Zoltu <micah@zoltu.net>
2021-03-02 21:06:22 +08:00
Pooja Ranjan
50177ef2bd
Removing non-existing EIPs from ERC. (#3218) 2021-01-29 16:11:11 +08:00
lightclient
869ece2a54
update eip-1 implementation definition (#3153) 2020-12-05 16:19:10 +08:00
Micah Zoltu
889bf6b844
EIP-1: Removes history and updated list. (#3100)
Let the change control system do what the change control system was designed to do.  It is entirely redundant to store change history in the EIP itself and it just adds an ever growing clutter to an already too long (IMO) process description.  If anyone wants to see the history they easily can.  Also, the history section said to see the history button in the top right of this EIP but that only works if you view this EIP from GitHub, not from any other interface.
2020-12-05 16:16:03 +08:00
Alex Beregszaszi
9c5210a3d4
EIP-1: require at least one github username (#2969)
This has been discussed a few times. The main problem is that editors have a challenge finding EIP authors and getting their response, unless there is a clear GitHub username. This is blocking a lot of outstanding change requests.
2020-11-06 15:10:02 +08:00
lightclient
aa6ea0b111
Update EIP statuses (#3096)
I'm updating EIP statuses according to #2996. The mappings are as follows:

```
Draft => Draft
Last Call => Last Call
Accepted => Final
Final => Final
Superseded => Final
Abandoned => Withdrawn
Rejected => Withdrawn
Active => Living
```
2020-11-06 12:41:46 +08:00
James Hancock
639aba8e5b
Update to All Status and the EIP process flow for EIP-1 (#2996)
The proposed Status to changes to EIP-1 inline with clarifiying the EIP repo as soley a standardization body.

Decisions made during the 17th EIPIP meeting. ethereum-cat-herders/EIPIP#33
2020-11-05 18:07:11 +08:00
Micah Zoltu
15f61ed0fd
Adds rule to EIP-1 that references to other EIPs must use relative path format and the first reference must be linked. (#2947)
I have gone through and updated all existing EIPs to match this rule, including EIP-1.

In some cases, people were using markdown citations, I suspect because the long-form was a bit verbose to inline.  Since the relative path is quite short, I moved these to inline but I wouldn't be opposed to putting them back to citation format if that is desired by the authors.

In doing the migration/cleanup, I found some EIP references to EIPs that don't actually exist.  In these cases I tried to excise the reference from the EIP as best I could.

It is worth noting that the Readme actually already had this rule, it just wasn't expressed properly in EIP-1 and the "Citation Format" section of the readme I think caused people a bit of confusion (when citing externally, you should use the citation format).
2020-09-30 12:22:43 +08:00
Alex Beregszaszi
f8e7c028f5
Simplify the EIP template (#2939)
* Try to clarify the meaning of EIP fields

* Remove unhelpful extra comments in the template

* Change EIP-1491 from CRLF to LF

* Remove template comments from EIPs

* Fix heading: Abstarct -> Abstract

* Update EIP-2014

* Change author list of EIP-1
2020-09-08 17:32:52 +08:00
Alex Beregszaszi
efcc99ac62
Clarify auxiliary/image files and the template in EIP-1 (#2921) 2020-08-29 13:07:46 +01:00
lightclient
3194278525
Switch validator to eipv (#2860)
* switch to eipv

* fix

* fix

* 1153 remove trailing whitespace

* remove file name checks

* 615 remo whitespace before comma

* 884 remove extra single-quotes

* 1337 remove whitespace before comma

* 1057 remove extra spaces after comma

* 2470 update created date to Y/M/D format

* 1078 update required eips to be in ascending order

* 2477 update required eips to be in ascending order

* 1271 remove extra whitespace

* 2767 required eipupdated to be in ascending order

* 2525 update created date to Y/M/D format

* 2458 remove trailing whitespace

* 1884 remove trailing whitespace

* 712 authors should be on a single line

* 601 remove extra whitespace

* 1485 remove unneeded parentheses

* 634 remove trailing whitespace

* 2657 update discussions-to to correct spelling

* 2009 remove trailing whitespace

* 998 required eips updated to be in ascending order

* 1186 remove trailing whitespace

* 1470 remove extra whitespace

* 1895 update created date to Y/M/D format

* 2747 remove extra whitespace

* 1613 remove leading whitespace

* 1571 can'have both handle and email in author field

* 1191 remove trailing whitespace

* 1973 remove trailing whitespace

* 196 don't wrap title field

* 1679 required eips must be in ascending order

* 1620 author can't have both handle and email

* 197 don't line wrap title field

* 2378 remove extra newline

* 1355 author can't have both handle and email

* 698 update created date to Y/M/D format

* 2193 required eips must be in ascending order

* 214 remove extra info after author email

* use v0.0.3 of eipv

* 1 remove malformed field

* bump eipv to v0.0.4

* cache eipv build

* 1485 remove extra author info

* 2771 removing extra whitespaces
2020-08-10 11:18:25 -05:00
lightclient
9119a4f0a1
Update to canonical eip-X format (#2734)
It appears that the format `EIP-X` is preferred to `EIPX`:

```console
$ grep "EIP-[0-9]+" * | wc -l
373

$ grep "EIP[0-9]+" * | wc -l
118
```

Also note that several of the `EIPX` references are coming from `index.html` and `EIPS/eip-1.md`.

```console
$ grep "EIP[0-9]+" index.html | wc -l
4

$ grep "EIP[0-9]+" EIPS/eip-1.md | wc -l
13
```

I have updated `index.html` and `eip-1` accordingly.
2020-07-17 16:58:43 +08:00
lightclient
95df780f67
add micah zoltu as eip editor (#2788) 2020-07-17 01:29:06 +08:00
tintin
d318362e9e Adding mandatory "Security Considerations" to EIP-1 (#1963)
* add mandatory "security considerations" to EIP-1 and template EIP-x

* security considerations: clarify wording and process

* security considerations: update eip-1

* Add updated date to EIP-1

Co-authored-by: Alex Beregszaszi <alex@rtfs.hu>
2019-12-21 02:04:06 +00:00
William Entriken
d5259bc809 Fix spelling of GitHub [R4R] (#2369) 2019-11-22 21:02:58 +00:00
Alex Beregszaszi
3fe4229cc4 EIP-1: clarify the process around core EIPs (#2196) 2019-09-18 17:36:01 +02:00
Alex Beregszaszi
81b36ca559 EIP-1: remove requirement for simple summary (#2186) 2019-09-15 19:55:17 +02:00
Alex Beregszaszi
880184aa52
EIP-1: formatting fixes and clarifications (#2236)
* EIP-1: make category field in EIP more clear

* Better heading in README

* EIP-2: fix typo in rendering

* EIP-1: clarify that an EIP can move from the Abandoned status to the Draft status

Also clarify that EIPs cannot move from the Rejected and Superseded states.

* EIP-1: rename WIP status to Idea

* EIP-1: change template formatting to fix markdown rendering

With angle brackets markdown renders them as HTML tags sometimes (depending on the rendering engine).

* EIP-1812: change copyright link to the correct CC0 link
2019-09-15 17:51:34 +01:00
Alex Beregszaszi
a83a10fedf
Rename eip-X template to eip-template (#2201)
* Rename eip-X template to eip-template

To reduce potential confusion.

* Rename explanation of assets/eip-X to assets/eip-N
2019-07-23 10:32:39 +01:00
Alex Beregszaszi
b241c17b6a Remove Deferred from the status list (#2162) 2019-07-17 23:35:03 +02:00
Tim Beiko
4a488ee68d Expand EIP Championing Section in EIP-1 (#1991)
* Update eip-1.md

* Update EIPS/eip-1.md

Co-Authored-By: timbeiko <t.beiko23@gmail.com>

* Update EIP-1 based on reviewer feedback

* Remove qualifiers

Based on @carver's comments.

* Rephrase based on review feedback

Rephrase based on review feedback
2019-07-13 18:28:58 +01:00
Alex Beregszaszi
27ea3a138b Introduced Abandoned status in EIP-1 (#2051)
* Introduced Abandoned status in EIP-1

* Fix typo
2019-06-28 09:34:47 +12:00
Greg Colvin
63a04a1279
Merge pull request #1968 from axic/eip1-opcodes
Add special requirement in EIP-1 for mentioning EVM instructions
2019-06-12 09:18:12 -06:00
Alex Beregszaszi
6366821e02
Mention that the header is also called "front matter" in EIP1 (#2037) 2019-05-21 04:34:16 +01:00
Alex Beregszaszi
6f35f9f376 Add special requirement for mentioning EVM instructions 2019-05-19 17:52:33 +01:00
Tim Beiko
0911b55122 Re-order EIP categories (#1989) 2019-05-11 08:24:37 +02:00
William Entriken
6f4a947ff0 Fix typos (#1899) 2019-05-08 15:36:26 +01:00
Greg Colvin
7cdf2de234
Add editors 2019-05-03 15:34:38 -06:00
William Entriken
035a021168 Update HTTP->HTTPS when both URLs work (#1714) 2019-03-09 08:56:08 +01:00
Alex Beregszaszi
4b4b7123bd Introduce "updated" date header in EIP-1 (#1697) 2019-03-08 13:16:22 +01:00
Albert
53f107c097 Remove reference to EIP-59 in EIP-1 (#1743) 2019-03-08 12:14:39 +01:00
Paweł Bylica
b101fb7932
EIP-1: Fix typo 2019-02-06 12:32:06 +01:00
Alex Beregszaszi
b17d0d6b01 EIP1 formatting improvements (#1510)
* Format the author header more nicely

* Use code highlighting on header fields

* Include proper headings for the header descriptions

* Group discussions-to requiements in a single place

* Clarify date formats in a single place
2019-01-11 08:59:03 +13:00
William Entriken
3d1a0843e4 Explicitly show how the review end date will be set (#1477) 2018-10-15 11:52:44 +01:00
Alex Beregszaszi
7497eb1d71 Add emphasis to "exceptional statuses" the same way as in the other cases (above) 2018-09-18 17:48:27 -05:00
Alex Beregszaszi
b6c339440a Fix backtick typos in EIP1 2018-09-18 17:48:27 -05:00
Micah Zoltu
4f8f1cbd1d Changes EIP-1 wording to focus on technicals not community sentiment. (#1224)
* Changes EIP-1 wording to focus on technicals not community sentiment.

All of the recent changes to the EIP process have been made to ensure that the EIP process is a technical one, and not one of sentiment analysis.  There is a lot of discussion going on with regards to how we can improve the process and get valid community sentiment analysis pre-fork, but there doesn't exist a complete solution yet at this time (just proposals).

It appears that the Last Call PR introduced sentiment analysis into the process, which I do not believe was intended.  From my recollection of the discussions around the Last Call stuff, the goal wasn't to fundamentally change how governance works, but rather to ensure that EIPs don't get stuck indefinitely in limbo.

This change simply removes the sentiment analysis wording from the process and makes it more clear that the EIP process is about gauging technical feasibility, not making judgement calls as to whether or not a thing is a good idea or not.

* Adds Active state
2018-08-07 10:31:44 +01:00
Zainan Victor Zhou
0580dea7dc Update EIP-1 to fix discussion-to and resolution URL field (#1281)
* Add notion that Github PR can't be discussion-to

* Update eip-1.md

* Update <url> it is interpret as HTML tag

* Update eip-1.md

* Update eip-1.md

* Update eip-1.md
2018-08-02 16:13:02 +01:00
William Entriken
e8b64f61e1 Add new two-week review process to EIPs (#1100)
* Add new two-week review process to EIPs

* Add ACCEPTED status, thanks @arachnid

* Use last call, thanks @arachnid

* Add other authors

* Re-add "request to merge"

* Add accepted as draft

* Match statuses to words used in text

* Match whitespace

* Add last call RSS

* add RSS link to EIP1

* Update deferred wording

* Provide

* "EIP authors can request"

* Correct HTML error

* review-period last date only

* Briefer review end date name

* alse

* Fully document statuses and transitions

* One implementation for draft

* Focus on the goal

* Use prior definition of final

* Use Accepted

* Use Accepted

* PR is the preferred mechanism to request status changes

* hide markdown formatting
2018-06-04 16:22:55 +01:00
William Entriken
79bd95f017 Fix formatting EIP-1 (#1112)
* Fix formatting

* Correct EIP process
2018-05-24 17:18:20 +01:00
James Ray
06ac958839 EIP-1 minors edits: clarify some sections on EIP collaborators and editors, cross-links, links, grammar, etc. (#1019)
* EIP-1 minors edits: clarify some sections on EIP collaborators and editors, cross-links, links, grammar, etc.

* Add a link for [Ethereum philosophy](https://github.com/ethereum/wiki/wiki/White-Paper#philosophy) to the section in the white paper that was originally removed and which I re-added recently.
* Revise the format for the author header (names can be optional for anonymity).
* History edits (link to revision history + a minor edit).
* Add cross-links to other sections for better readability and clarity.
* Add clarifications on approval before merging from both editors and authors.
* Add more links for discussion channels
* Link to other clients and eips.ethereum.org.
* Reorder EIP editors roughly based on recent contributions.
* Other minor edits: grammar, etc.

* Add a link to core dev meetings

* discussion*s*
2018-04-24 11:30:03 +01:00
Jacques Dafflon
5b8055c85e Move EIP assets to assets folder (#977)
- Create `assets` folder
- Move existing EIPs (1, 107, 858) assets into the `assets` folder
- Update link to assets in EIPs 1, 107 and 858
- Describe the inclusion of assets for EIPs in `README.md`
2018-04-06 13:39:26 +01:00
Nick Johnson
a90a5a3e58
Add autocommit bot and descriptions of it (#967)
* Add autocommit bot and descriptions of it

* Update README.md

* Update EIP 1 with some changes to process
2018-04-03 20:02:04 +01:00
Nick Johnson
e2232f380e Fix travis build script, and more typos identified by it 2018-03-23 16:56:22 +00:00
Nick Johnson
7038c5f9b9 Add pages for each EIP type, improve listing tables with links 2018-03-21 15:55:18 +00:00
Nick Johnson
264e8be5ed Use pretty URLs 2018-03-21 13:36:46 +00:00