Before you initiate a pull request, please read the EIP-1 process document. Ideas should be thoroughly discussed on Ethereum Research or Ethereum Magicians first.
This repository tracks ongoing improvements to Ethereum. It contains:
- The EIP status page, tracking protocols for Ethereum clients and applications
- The process document that governs how protocols are published here
For help implementing an EIP, please visit Ethereum Stack Exchange.
If you would like to become an EIP Editor, please check EIP-5069.
The goal of the EIP project is to document standardized protocols for Ethereum clients and applications and to document them in a high quality and implementable way.
The canonical URL for a EIP that has achieved draft status at any point is at https://eips.ethereum.org/. For example, the canonical URL for EIP-1 is https://eips.ethereum.org/EIPS/eip-1.
Please consider anything which is not published on https://eips.ethereum.org/ as a working paper.
And please consider anything published at https://eips.ethereum.org/ with a status of "draft" as an incomplete draft.
This repository contains an "auto merge" feature to ease the workload for EIP editors. Pull requests to any EIP will be auto-merged if the EIP's authors approve the PR on GitHub. This is handled by the EIP-Bot.
Pull requests in this repository must pass automated validation checks:
- HTML formatting and broken links are checked using html-proofer.
- EIP front matter and formatting are checked using EIP Validator.
It is possible to run the EIP validator locally:
cargo install eipv
eipv <INPUT FILE / DIRECTORY>-
Open Terminal.
-
Check whether you have Ruby 2.1.0 or higher installed:
ruby --version
-
If you don't have Ruby installed, install Ruby 2.1.0 or higher.
-
Install Bundler:
gem install bundler
-
Install dependencies:
bundle install
-
Bundle assets and start the server:
bundle exec jekyll serve -
Preview your local Jekyll site in your web browser at http://localhost:4000.
More information on Jekyll and GitHub pages here.