You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: EIPS/eip-1.md
+22-18Lines changed: 22 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -117,29 +117,31 @@ EIPs should be written in [markdown] format. Image files should be included in a
117
117
EIP Header Preamble
118
118
-------------------
119
119
120
-
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.
120
+
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.
121
121
122
-
`EIP: ` <EIPnumber> (this is determined by the EIP editor)
122
+
`eip: ` <EIPnumber> (this is determined by the EIP editor)
123
123
124
-
`Title: `<EIPtitle>
124
+
`title: `<EIPtitle>
125
125
126
-
`Author: `<list of author's real names and optionally, email address>
126
+
`author: `<list of author's real names and optionally, email address>
127
127
128
-
` * Discussions-To: ` <emailaddress>
128
+
` * discussions-to: ` <emailaddress>
129
129
130
-
`Status: `<Draft | Active | Accepted | Deferred | Rejected | Withdrawn | Final | Superseded>
130
+
`status: `<Draft | Active | Accepted | Deferred | Rejected | Withdrawn | Final | Superseded>
`Created: `<date created on, in ISO 8601 (yyyy-mm-dd) format>
134
+
`created: `<date created on, in ISO 8601 (yyyy-mm-dd) format>
135
135
136
-
` * Replaces: `<EIPnumber>
136
+
` * requires: `<EIP number(s)>
137
137
138
-
` * Superseded-By: `<EIPnumber>
138
+
` * replaces: `<EIP number(s)>
139
139
140
-
` * Resolution: `<url>
140
+
` * superseded-by: `<EIP number(s)>
141
141
142
-
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
142
+
` * resolution: `<url>
143
+
144
+
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
143
145
144
146
Random J. User <address@dom.ain>
145
147
@@ -149,17 +151,19 @@ Random J. User
149
151
150
152
if the email address is not given.
151
153
152
-
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.
154
+
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.
155
+
156
+
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.
153
157
154
-
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.
158
+
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).
155
159
156
-
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).
160
+
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.
157
161
158
-
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.
162
+
EIPs may have a requires header, indicating the EIP numbers that this EIP depends on.
159
163
160
-
EIPs may have a Requires header, indicating the EIP numbers that this EIP depends on.
164
+
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.
161
165
162
-
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.
166
+
Headers that permit lists must separate elements with commas.
0 commit comments