mirror of
https://github.com/status-im/EIPs.git
synced 2025-02-23 12:18:16 +00:00
774458ef71
In reality, the `Implementation` section almost always involves someone linking out to a personal or company repository when they create an EIP from the template. External repositories cause problems because: 1. Links move/change over time and eventually the link will be dead. 2. The implementation likely isn't CC0 as the EIP is, and naive users may follow the link not realizing it is GPL and they are screwing themselves legally. 3. People are using EIPs for advertising their project, and they look for any opportunity they can to link out to their project in the body of the EIP. 4. People often link to some monolithic repository (e.g., go-ethereum) as the "implementation" which is less than useful. Also, the description was written back when EIPs were part of the hard fork coordination process, so that has been rewritten. This change makes it so it is more clear that this section is optional and that external links are not the preferred solution to completing this section.
49 lines
3.7 KiB
Markdown
49 lines
3.7 KiB
Markdown
---
|
|
eip: <to be assigned>
|
|
title: <EIP title>
|
|
author: <a list of the author's or authors' name(s) and/or username(s), or name(s) and email(s), e.g. (use with the parentheses or triangular brackets): FirstName LastName (@GitHubUsername), FirstName LastName <foo@bar.com>, FirstName (@GitHubUsername) and GitHubUsername (@GitHubUsername)>
|
|
discussions-to: <URL>
|
|
status: Draft
|
|
type: <Standards Track, Meta, or Informational>
|
|
category (*only required for Standards Track): <Core, Networking, Interface, or ERC>
|
|
created: <date created on, in ISO 8601 (yyyy-mm-dd) format>
|
|
requires (*optional): <EIP number(s)>
|
|
replaces (*optional): <EIP number(s)>
|
|
---
|
|
|
|
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`.
|
|
|
|
The title should be 44 characters or less.
|
|
|
|
## Simple Summary
|
|
If you can't explain it simply, you don't understand it well enough." Provide a simplified and layman-accessible explanation of the EIP. Imagine an email subject line, GitHub PR title, or forum post title.
|
|
|
|
## Abstract
|
|
A short (~200 word) description of the technical issue being addressed.
|
|
|
|
## Motivation
|
|
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 (go-ethereum, parity, cpp-ethereum, ethereumj, ethereumjs, and [others](https://github.com/ethereum/wiki/wiki/Clients)).
|
|
|
|
## 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.
|
|
|
|
## Backwards Compatibility
|
|
All EIPs that introduce backwards incompatibilities must include a section describing these incompatibilities and their severity. The EIP must explain how the author proposes to deal with these incompatibilities. EIP submissions without a sufficient backwards compatibility treatise may be rejected outright.
|
|
|
|
## Test Cases
|
|
Test cases for an implementation are mandatory for EIPs that are affecting consensus changes. Other EIPs can choose to include links to test cases if applicable.
|
|
|
|
## Reference Implementation
|
|
An optional section that contains a reference/example implementation that people can use to assist in understanding or implementing this specification. If the implementation is too large to reasonably be included inline, then consider adding it as one or more files in `../assets/eip-####/`.
|
|
|
|
## Security Considerations
|
|
All EIPs must contain a section that discusses the security implications/considerations relevant to the proposed change. Include information that might be important for security discussions, surfaces risks and can be used throughout the life cycle of the proposal. E.g. include security-relevant design decisions, concerns, important discussions, implementation-specific guidance and pitfalls, an outline of threats and risks and how they are being addressed. EIP submissions missing the "Security Considerations" section will be rejected. An EIP cannot proceed to status "Final" without a Security Considerations discussion deemed sufficient by the reviewers.
|
|
|
|
## Copyright
|
|
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
|