You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**Before you initiate a pull request**, please read the [EIP-1](https://eips.ethereum.org/EIPS/eip-1) process document. Ideas should be thoroughly discussed on [Ethereum Research](https://ethresear.ch/t/read-this-before-posting/8) or [Ethereum Magicians](https://ethereum-magicians.org/) first.
4
4
5
-
Ethereum Improvement Proposals (EIPs) describe standards for the Ethereum platform, including core protocol specifications, client APIs, and contract standards. **Browse all current and draft EIPs on [the official EIP site](https://eips.ethereum.org/).**
5
+
This repository tracks ongoing improvements to Ethereum. It contains:
6
6
7
-
**Before you initiate a pull request**, please read the [EIP-1](https://eips.ethereum.org/EIPS/eip-1) process document.
7
+
- The [EIP status page](https://eips.ethereum.org), tracking protocols for Ethereum clients and applications
8
+
- The [process document](https://eips.ethereum.org/EIPS/eip-1) that governs how protocols are published here
8
9
9
-
Once your first PR is merged, we have a bot that helps out by automatically merging PRs to draft EIPs. For this to work, it has to be able to tell that you own the draft being edited. Make sure that the 'author' line of your EIP contains either your GitHub username or your email address inside \<triangular brackets>. If you use your email address, that address must be the one publicly shown on [your GitHub profile](https://github.com/settings/profile).
10
+
For help *implementing* an EIP, please visit [Ethereum Stack Exchange](https://ethereum.stackexchange.com).
10
11
11
-
## Project Goal
12
+
## Mission
12
13
13
-
The Ethereum Improvement Proposals repository exists as a place to share concrete proposals with potential users of the proposal and the Ethereum community at large.
14
+
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.
14
15
15
16
## Preferred Citation Format
16
17
@@ -20,54 +21,57 @@ Please consider anything which is not published on https://eips.ethereum.org/ as
20
21
21
22
And please consider anything published at https://eips.ethereum.org/ with a status of "draft" as an incomplete draft.
22
23
23
-
#Validation
24
+
## Automerger
24
25
25
-
EIPs must pass some validation tests. The EIP repository ensures this by running tests using [html-proofer](https://rubygems.org/gems/html-proofer) and [eipv](https://github.com/lightclient/eipv).
26
+
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](https://github.com/ethereum/EIP-Bot).
27
+
28
+
## Validation
29
+
30
+
Pull requests in this repository must pass automated validation checks:
31
+
32
+
* HTML formatting and broken links are [checked](https://github.com/ethereum/EIPs/blob/master/.travis-ci.sh) using [html-proofer](https://rubygems.org/gems/html-proofer).
33
+
* EIP front matter and formatting are [checked](https://github.com/ethereum/EIPs/blob/master/.github/workflows/auto-merge-bot.yml) using [EIP Validator](https://github.com/ethereum/eipv).
26
34
27
35
It is possible to run the EIP validator locally:
28
36
```sh
29
37
cargo install eipv
30
38
eipv <INPUT FILE / DIRECTORY>
31
39
```
32
40
33
-
# Automerger
34
-
35
-
The EIP repository contains an "auto merge" feature to ease the workload for EIP editors. If a change is made via a PR to a draft EIP, then the authors of the EIP can GitHub approve the change to have it auto-merged. This is handled by the [EIP-Bot](https://github.com/ethereum/EIP-Bot).
41
+
## Build the status page locally
36
42
37
-
# Local development
38
-
39
-
## Prerequisites
43
+
### Install prerequisites
40
44
41
45
1. Open Terminal.
42
46
43
47
2. Check whether you have Ruby 2.1.0 or higher installed:
44
48
45
-
```sh
46
-
$ ruby --version
47
-
```
49
+
```sh
50
+
ruby --version
51
+
```
48
52
49
53
3. If you don't have Ruby installed, install Ruby 2.1.0 or higher.
50
54
51
55
4. Install Bundler:
52
56
53
-
```sh
54
-
$ gem install bundler
55
-
```
57
+
```sh
58
+
gem install bundler
59
+
```
56
60
57
61
5. Install dependencies:
58
62
59
-
```sh
60
-
$ bundle install
61
-
```
63
+
```sh
64
+
bundle install
65
+
```
62
66
63
-
## Build your local Jekyll site
67
+
###Build your local Jekyll site
64
68
65
69
1. Bundle assets and start the server:
66
70
67
-
```sh
68
-
$ bundle exec jekyll serve
69
-
```
71
+
```sh
72
+
bundle exec jekyll serve
73
+
```
70
74
71
-
2. Preview your local Jekyll site in your web browser at `http://localhost:4000`.
75
+
2. Preview your local Jekyll site in your web browser at http://localhost:4000.
72
76
73
77
More information on Jekyll and GitHub pages [here](https://help.github.com/en/enterprise/2.14/user/articles/setting-up-your-github-pages-site-locally-with-jekyll).
0 commit comments