Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update EIP-1: Suggest that EIPs use RFC 8174 (updates RFC 2119) #5466

Merged
merged 14 commits into from
Oct 8, 2022
Merged

Update EIP-1: Suggest that EIPs use RFC 8174 (updates RFC 2119) #5466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
3d98bbf
EIP-1: propose to adopt RFC 8174 (updates 2119)
xinbenlv Aug 16, 2022
2b38fda
Merge branch 'ethereum:master' into patch-23
xinbenlv Aug 17, 2022
3aa4350
Update eip-template.md
xinbenlv Aug 17, 2022
5864358
Update eip-template.md
xinbenlv Aug 17, 2022
a69b4c0
Update eip-1.md
xinbenlv Aug 18, 2022
40b967c
Update eip-template.md
xinbenlv Aug 18, 2022
4441894
Update EIPS/eip-1.md
xinbenlv Aug 19, 2022
366bbf0
Update eip-template.md
xinbenlv Aug 19, 2022
3d7260d
Merge branch 'master' into patch-23
Pandapip1 Aug 28, 2022
b06b18f
Merge branch 'master' into patch-23
xinbenlv Sep 5, 2022
3caa94e
Update eip-1.md
xinbenlv Oct 5, 2022
168ed74
Update eip-template.md
xinbenlv Oct 5, 2022
9559da5
Update eip-1.md
xinbenlv Oct 5, 2022
3a2352b
Apply suggestions from code review
SamWilsn Oct 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions EIPS/eip-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,11 +265,11 @@ The `description` field in the preamble:

When referring to an EIP by number, it should be written in the hyphenated form `EIP-X` where `X` is the EIP's assigned number.

### RFC 2119
### RFC 2119 and RFC 8174

EIPs are encouraged to follow [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt) for terminology and to insert the following at the beginning of the Specification section:
EIPs are encouraged to follow [RFC 2119](https://www.ietf.org/rfc/rfc2119.html) and [RFC 8174](https://www.ietf.org/rfc/rfc8174.html) for terminology and to insert the following at the beginning of the Specification section:

> The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.
> The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 and RFC 8174.

## History

Expand Down
2 changes: 1 addition & 1 deletion eip-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Abstract is a multi-sentence (short paragraph) technical summary. This should be
The motivation section should describe the "why" of this EIP. What problem does it solve? Why should someone want to implement this standard? What benefit does it provide to the Ethereum ecosystem? What use cases does this EIP address?

## Specification
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 and RFC 8174.

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 (go-ethereum, parity, cpp-ethereum, ethereumj, ethereumjs, and [others](https://github.com/ethereum/wiki/wiki/Clients)).

Expand Down