-
Notifications
You must be signed in to change notification settings - Fork 5.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
- Loading branch information
Showing
1 changed file
with
35 additions
and
17 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -102,17 +102,15 @@ Each EIP must begin with an RFC 822 style header preamble, preceded and followed | |
|
||
` * discussions-to:` \<a url pointing to the official discussion thread\> | ||
|
||
- :x: `discussions-to` can not be a Github `Pull-Request`. | ||
|
||
` status:` <Draft | Last Call | Accepted | Final | Active | Deferred | Rejected | Superseded> | ||
|
||
`* review-period-end:` YYYY-MM-DD | ||
`* review-period-end:` <date review period ends> | ||
|
||
` type:` <Standards Track (Core, Networking, Interface, ERC) | Informational | Meta> | ||
|
||
` * category:` <Core | Networking | Interface | ERC> | ||
|
||
` created:` <date created on, in ISO 8601 (yyyy-mm-dd) format> | ||
` created:` <date created on> | ||
|
||
` * requires:` <EIP number(s)> | ||
|
||
|
@@ -122,37 +120,57 @@ Each EIP must begin with an RFC 822 style header preamble, preceded and followed | |
|
||
` * resolution:` \<a url pointing to the resolution of this EIP\> | ||
|
||
#### Author header | ||
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 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: | ||
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 <[email protected]> | ||
> Random J. User <[email protected]> | ||
or | ||
|
||
Random J. User (@username) | ||
> Random J. User (@username) | ||
if the email address or GitHub username is included, and | ||
|
||
Random J. User | ||
> Random J. User | ||
if the email address is not given. | ||
|
||
Note: The resolution header is required for Standards Track EIPs only. It contains a URL that should point to an email message or other web resource where the pronouncement about the EIP is made. | ||
#### `resolution` header | ||
|
||
While an EIP is a draft, a discussions-to header will indicate the mailing list or URL where the EIP is being discussed. As mentioned above, examples for places to discuss your EIP include [Ethereum topics on Gitter](https://gitter.im/ethereum/topics), an issue in this repo or in a fork of this repo, [Ethereum Magicians](https://ethereum-magicians.org/) (this is suitable for EIPs that may be contentious or have a strong governance aspect), and [Reddit r/ethereum](https://www.reddit.com/r/ethereum/). No discussions-to header is necessary if the EIP is being discussed privately with the author. | ||
The `resolution` header is required for Standards Track EIPs only. It contains a URL that should point to an email message or other web resource where the pronouncement about the EIP is made. | ||
|
||
The type header specifies the type of EIP: Standards Track, Meta, or Informational. If the track is Standards please include the subcategory (core, networking, interface, or ERC). | ||
#### `discussions-to` header | ||
|
||
The category header specifies the EIP's category. This is required for standards-track EIPs only. | ||
While an EIP is a draft, a `discussions-to` header will indicate the mailing list or URL where the EIP is being discussed. As mentioned above, examples for places to discuss your EIP include [Ethereum topics on Gitter](https://gitter.im/ethereum/topics), an issue in this repo or in a fork of this repo, [Ethereum Magicians](https://ethereum-magicians.org/) (this is suitable for EIPs that may be contentious or have a strong governance aspect), and [Reddit r/ethereum](https://www.reddit.com/r/ethereum/). | ||
|
||
The created header records the date that the EIP was assigned a number. Both headers should be in yyyy-mm-dd format, e.g. 2001-08-14. | ||
No `discussions-to` header is necessary if the EIP is being discussed privately with the author. | ||
|
||
EIPs may have a requires header, indicating the EIP numbers that this EIP depends on. | ||
As a single exception, `discussions-to` cannot point to GitHub pull requests. | ||
|
||
EIPs may also have a superseded-by header indicating that an EIP has been rendered obsolete by a later document; the value is the number of the EIP that replaces the current document. The newer EIP must have a Replaces header containing the number of the EIP that it rendered obsolete. | ||
#### `type` header | ||
|
||
Headers that permit lists must separate elements with commas. | ||
The `type` header specifies the type of EIP: Standards Track, Meta, or Informational. If the track is Standards please include the subcategory (core, networking, interface, or ERC). | ||
|
||
#### `category` header | ||
|
||
The `category` header specifies the EIP's category. This is required for standards-track EIPs only. | ||
|
||
#### `created` header | ||
|
||
The `created` header records the date that the EIP was assigned a number. Both headers should be in yyyy-mm-dd format, e.g. 2001-08-14. | ||
|
||
#### `requires` header | ||
|
||
EIPs may have a `requires` header, indicating the EIP numbers that this EIP depends on. | ||
|
||
#### `superseded-by` and `replaces` headers | ||
|
||
EIPs may also have a `superseded-by` header indicating that an EIP has been rendered obsolete by a later document; the value is the number of the EIP that replaces the current document. The newer EIP must have a `replaces` header containing the number of the EIP that it rendered obsolete. | ||
|
||
## Auxiliary Files | ||
|
||
|