status-im
/
EIPs
mirror of https://github.com/status-im/EIPs.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update EIP 1 with header format changes, fix a few other EIP header issues

This commit is contained in:
Nick Johnson 2018-03-21 13:10:08 +00:00
parent 3e91f85825
commit c231d1c980
14 changed files with 50 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
EIPS/eip-1.md
View File

@ -117,29 +117,31 @@ EIPs should be written in [markdown] format. Image files should be included in a
EIP Header Preamble
-------------------
Each EIP must begin with an RFC 822 style header preamble. The headers must appear in the following order. Headers marked with "*" are optional and are described below. All other headers are required.
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.
` EIP: ` <EIP number> (this is determined by the EIP editor)
` eip: ` <EIP number> (this is determined by the EIP editor)
` Title: `<EIP title>
` title: `<EIP title>
` Author: `<list of author's real names and optionally, email address>
` author: `<list of author's real names and optionally, email address>
` * Discussions-To: ` <email address>
` * discussions-to: ` <email address>
` Status: `<Draft | Active | Accepted | Deferred | Rejected | Withdrawn | Final | Superseded>
` status: `<Draft | Active | Accepted | Deferred | Rejected | Withdrawn | Final | Superseded>
` Type: `<Standards Track (Core, Networking, Interface, ERC) | Informational | Process>
` type: `<Standards Track (Core, Networking, Interface, ERC) | Informational | Process>
` Created: `<date created on, in ISO 8601 (yyyy-mm-dd) format>
` created: `<date created on, in ISO 8601 (yyyy-mm-dd) format>
` * Replaces: `<EIP number>
` * requires: `<EIP number(s)>
` * Superseded-By: `<EIP number>
` * replaces: `<EIP number(s)>
` * Resolution: `<url>
` * superseded-by: `<EIP number(s)>
The Author header lists the names, and optionally the email addresses of all the authors/owners of the EIP. The format of the Author header value must be
` * resolution: `<url>
The author header lists the names, and optionally the email addresses of all the authors/owners of the EIP. The format of the author header value must be
Random J. User &lt;address@dom.ain&gt;
@ -149,17 +151,19 @@ 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.
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.
While an EIP is in private discussions (usually during the initial Draft phase), a Discussions-To header will indicate the mailing list or URL where the EIP is being discussed. No Discussions-To header is necessary if the EIP is being discussed privately with the author.
While an EIP is in private discussions (usually during the initial Draft phase), a discussions-to header will indicate the mailing list or URL where the EIP is being discussed. No discussions-to header is necessary if the EIP is being discussed privately with the author.
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).
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).
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.
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.
EIPs may have a Requires header, indicating the EIP numbers that this EIP depends on.
EIPs may have a requires header, indicating the EIP numbers that this EIP depends on.
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.
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.
Headers that permit lists must separate elements with commas.
Auxiliary Files
---------------

2
EIPS/eip-158.md
View File

@ -6,7 +6,7 @@ type: Standard Track
category: Core
status: Superseded
created: 2016-10-16
Superseded-By: 161
superseded-by: 161
---
# Specification

3
EIPS/eip-211.md
View File

@ -6,8 +6,7 @@ type: Standard Track
category: Core
status: Final
created: 2017-02-13
Requires:
Replaces: 5/8
replaces: 5,8
---
## Simple Summary

2
EIPS/eip-606.md
View File

@ -5,7 +5,7 @@ author: Alex Beregszaszi
type: Meta
status: Final
created: 2017-04-23
Requires: 2, 7
requires: 2, 7
---
## Abstract

2
EIPS/eip-607.md
View File

@ -5,7 +5,7 @@ author: Alex Beregszaszi
type: Meta
status: Final
created: 2017-04-23
Requires: 155, 160, 161, 170
requires: 155, 160, 161, 170
---
## Abstract

2
EIPS/eip-608.md
View File

@ -5,7 +5,7 @@ author: Alex Beregszaszi
type: Meta
status: Final
created: 2017-04-23
Requires: 150
requires: 150
---
## Abstract

2
EIPS/eip-609.md
View File

@ -6,7 +6,7 @@ type: Standard Track
category: Core
status: Final
created: 2017-04-23
Requires: 100, 140, 196, 197, 198, 211, 214, 649, 658
requires: 100, 140, 196, 197, 198, 211, 214, 649, 658
---
## Abstract

2
EIPS/eip-615.md
View File

@ -5,7 +5,7 @@ status: Draft
type: Core
author: Greg Colvin <greg@colvin.org>, Paweł Bylica, Christian Reitwiessner
created: 2016-12-10
Edited: 2017-25-4
edited: 2017-25-4
---
## Abstract

2
EIPS/eip-649.md
View File

@ -6,7 +6,7 @@ type: Standard Track
category: Core
status: Final
created: 2017-06-21
Replaces: 186
replaces: 186
---
## Simple Summary

4
EIPS/eip-658.md
View File

@ -6,8 +6,8 @@ type: Standard Track
category: Core
status: Final
created: 2017-06-30
Requires: 140
Replaces: 98
requires: 140
replaces: 98
---
## Abstract

2
EIPS/eip-681.md
View File

@ -6,7 +6,7 @@ type: Standard Track
category: ERC
status: Draft
created: 2017-08-01
Requires: 20, 137, 831
requires: 20, 137, 831
---
## Simple Summary

2
EIPS/eip-721.md
View File

@ -6,7 +6,7 @@ type: Standard
category: ERC
status: Draft
created: 2018-01-24
Requires: ERC-165
requires: ERC-165
---
## Simple Summary

2
EIPS/eip-868.md
View File

@ -6,7 +6,7 @@ type: Standard Track
category: Networking
status: Draft
created: 2018-02-02
Requires: EIP-8, EIP-778
requires: 8, 778
---
# Abstract

17
_layouts/eip.html
View File

@ -7,11 +7,24 @@ layout: default
<table>
<tr><th>Author</th><td>{{ page.author | xml_escape }}</td></tr>
{% if page["discussions-to"] != undefined %}
<tr><th>Discussions-To</th><td>{{ page["discussions-to"] | xml_escape }}</td></tr>
{% endif %}
<tr><th>Status</th><td>{{ page.status | xml_escape }}</td></tr>
<tr><th>Type</th><td>{{ page.type | xml_escape }}</td></tr>
<tr><th>Layer</th><td>{{ page.layer | xml_escape }}</td></tr>
<tr><th>Category</th><td>{{ page.category | xml_escape }}</td></tr>
<tr><th>Created</th><td>{{ page.created | xml_escape }}</td></tr>
{% if page.requires != undefined %}
<tr><th>Requires</th><td>{{ page.requires | xml_escape }}</td></tr>
{% endif %}
{% if page.replaces != undefined %}
<tr><th>Replaces</th><td>{{ page.replaces | xml_escape }}</td></tr>
{% endif %}
{% if page["superseded-by"] != undefined %}
<tr><th>Superseded by</th><td>{{ page["superseded-by"] | xml_escape }}</td></tr>
{% endif %}
{% if page.resolution != undefined %}
<tr><th>Resolution</th><td>{{ page.resolution | xml_escape }}</td></tr>
{% endif %}
</table>
{{ content }}