From aea7bfceb5551395d0ca1a9faeab65eb19c6410a Mon Sep 17 00:00:00 2001 From: Nick Johnson Date: Wed, 21 Mar 2018 13:14:02 +0000 Subject: [PATCH] Update eip-X template, more tweaks to EIP 1 and jekyll template. --- EIPS/eip-1.md | 4 ++++ _layouts/eip.html | 3 +++ eip-X.md | 27 ++++++++++++++------------- 3 files changed, 21 insertions(+), 13 deletions(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index c2374d98..ae65291d 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -131,6 +131,8 @@ Each EIP must begin with an RFC 822 style header preamble, preceded and followed ` type: ` +` * category `: + ` created: ` ` * requires: ` @@ -157,6 +159,8 @@ While an EIP is in private discussions (usually during the initial Draft phase), 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 category header specifies the EIP's category. This is required for standards-track EIPs only. + 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. diff --git a/_layouts/eip.html b/_layouts/eip.html index d55a709c..bb274d67 100644 --- a/_layouts/eip.html +++ b/_layouts/eip.html @@ -12,6 +12,9 @@ layout: default {% endif %} Status{{ page.status | xml_escape }} Type{{ page.type | xml_escape }} + {% if page.category != undefined %} + Category{{ page.category | xml_escape }} + {% endif %} Created{{ page.created | xml_escape }} {% if page.requires != undefined %} Requires{{ page.requires | xml_escape }} diff --git a/eip-X.md b/eip-X.md index 99de9188..5536a2e4 100644 --- a/eip-X.md +++ b/eip-X.md @@ -1,19 +1,20 @@ +--- +eip: +title: +author: +discussions-to: +status: Draft +type: +category (*only required for Standard Track): +created: +requires (*optional): +replaces (*optional): +--- + This is the suggested template for new EIPs. Note that an EIP number will be assigned by an editor. When opening a pull request to submit your EIP, please use an abbreviated title in the filename, `eip-draft_title_abbrev.md`. -## Preamble - - EIP: - Title: - Author: - Type: - Category (*only required for Standard Track): - Status: Draft - Created: - Requires (*optional): - Replaces (*optional): - The title should be 44 characters or less. ## Simple Summary @@ -26,7 +27,7 @@ A short (~200 word) description of the technical issue being addressed. The motivation is critical for EIPs that want to change the Ethereum protocol. It should clearly explain why the existing protocol specification is inadequate to address the problem that the EIP solves. EIP submissions without sufficient motivation may be rejected outright. ## Specification -The technical specification should describe the syntax and semantics of any new feature. The specification should be detailed enough to allow competing, interoperable implementations for any of the current Ethereum platforms (cpp-ethereum, go-ethereum, parity, ethereumj, ethereumjs, ...). +The technical specification should describe the syntax and semantics of any new feature. The specification should be detailed enough to allow competing, interoperable implementations for any of the current Ethereum platforms (cpp-ethereum, go-ethereum, parity, ethereumj, ethereumjs, ...). ## Rationale The rationale fleshes out the specification by describing what motivated the design and why particular design decisions were made. It should describe alternate designs that were considered and related work, e.g. how the feature is supported in other languages. The rationale may also provide evidence of consensus within the community, and should discuss important objections or concerns raised during discussion.