Skip to content

Commit

Permalink
add rfc section for style
Browse files Browse the repository at this point in the history
  • Loading branch information
sambacha committed Dec 16, 2024
1 parent 44c4b6c commit d574f9b
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,36 @@
# Draft Specifications for EIP and ERC's

## Writing Style

> [!Note]
> see <https://www.rfc-editor.org/rfc/rfc2119.txt>
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.

Note that the force of these words is modified by the requirement
level of the document in which they are used.

1. MUST This word, or the terms "REQUIRED" or "SHALL", mean that the
definition is an absolute requirement of the specification.

2. MUST NOT This phrase, or the phrase "SHALL NOT", mean that the
definition is an absolute prohibition of the specification.

3. SHOULD This word, or the adjective "RECOMMENDED", mean that there
may exist valid reasons in particular circumstances to ignore a
particular item, but the full implications must be understood and
carefully weighed before choosing a different course.

4. SHOULD NOT This phrase, or the phrase "NOT RECOMMENDED" mean that
there may exist valid reasons in particular circumstances when the
particular behavior is acceptable or even useful, but the full
implications should be understood and the case carefully weighed
before implementing any behavior described with this label.


## EIP Proposal for new Transaction Type and corresponding RPC

## Draft EIPS

Check warning on line 36 in README.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (EIPS)
Expand Down

0 comments on commit d574f9b

Please sign in to comment.