diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 50d55747..f8a560b0 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -116,7 +116,7 @@ Each EIP should have the following parts: ## EIP Formats and Templates EIPs should be written in [markdown] format. -Image files should be included in a subdirectory of the `assets` folder for that EIP as follows: `assets/eip-X` (for eip **X**). When linking to an image in the EIP, use relative links such as `../assets/eip-X/image.png`. +Image files should be included in a subdirectory of the `assets` folder for that EIP as follows: `assets/eip-N` (where **N** is to be replaced with the EIP number). When linking to an image in the EIP, use relative links such as `../assets/eip-1/image.png`. ## EIP Header Preamble diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 28fdd587..f18eb4fd 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,5 +1,5 @@ -ATTENTION! If you would like to submit an EIP and it has already been written as a draft (see the [template](https://github.com/ethereum/EIPs/blob/master/eip-X.md) for an example), please submit it as a [Pull Request](https://github.com/ethereum/EIPs/pulls). +ATTENTION! If you would like to submit an EIP and it has already been written as a draft (see the [template](https://github.com/ethereum/EIPs/blob/master/eip-template.md) for an example), please submit it as a [Pull Request](https://github.com/ethereum/EIPs/pulls). If you are considering a proposal but would like to get some feedback on the idea before submitting a draft, then continue opening an Issue as a thread for discussion. Note that the more clearly and completely you state your idea the higher the quality of the feedback you are likely to receive. diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 03f1f3da..bff8b61e 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,4 @@ -When opening a pull request to submit a new EIP, please use the suggested template: https://github.com/ethereum/EIPs/blob/master/eip-X.md +When opening a pull request to submit a new EIP, please use the suggested template: https://github.com/ethereum/EIPs/blob/master/eip-template.md We have a GitHub bot that automatically merges some PRs. It will merge yours immediately if certain criteria are met: diff --git a/README.md b/README.md index 5dcd63d8..843d7f05 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,12 @@ A browsable version of all current and draft EIPs can be found on [the official 1. Review [EIP-1](EIPS/eip-1.md). 2. Fork the repository by clicking "Fork" in the top right. - 3. Add your EIP to your fork of the repository. There is a [template EIP here](eip-X.md). + 3. Add your EIP to your fork of the repository. There is a [template EIP here](eip-template.md). 4. Submit a Pull Request to Ethereum's [EIPs repository](https://github.com/ethereum/EIPs). Your first PR should be a first draft of the final EIP. It must meet the formatting criteria enforced by the build (largely, correct metadata in the header). An editor will manually review the first PR for a new EIP and assign it a number before merging it. Make sure you include a `discussions-to` header with the URL to a discussion forum or open GitHub issue where people can discuss the EIP as a whole. -If your EIP requires images, the image files should be included in a subdirectory of the `assets` folder for that EIP as follows: `assets/eip-X` (for eip **X**). When linking to an image in the EIP, use relative links such as `../assets/eip-X/image.png`. +If your EIP requires images, the image files should be included in a subdirectory of the `assets` folder for that EIP as follows: `assets/eip-N` (where **N** is to be replaced with the EIP number). When linking to an image in the EIP, use relative links such as `../assets/eip-1/image.png`. 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 . If you use your email address, that address must be the one publicly shown on [your GitHub profile](https://github.com/settings/profile). diff --git a/_config.yml b/_config.yml index b0fbe061..5eac0624 100644 --- a/_config.yml +++ b/_config.yml @@ -54,4 +54,4 @@ exclude: - vendor/cache/ - vendor/gems/ - vendor/ruby/ - - eip-X.md + - eip-template.md diff --git a/eip-X.md b/eip-template.md similarity index 100% rename from eip-X.md rename to eip-template.md diff --git a/index.html b/index.html index 8e495bde..670b8e56 100644 --- a/index.html +++ b/index.html @@ -10,7 +10,7 @@ title: Home

Ethereum Improvement Proposals (EIPs) describe standards for the Ethereum platform, including core protocol specifications, client APIs, and contract standards.

Contributing

-

First review EIP-1. Then clone the repository and add your EIP to it. There is a template EIP here. Then submit a Pull Request to Ethereum's EIPs repository.

+

First review EIP-1. Then clone the repository and add your EIP to it. There is a template EIP here. Then submit a Pull Request to Ethereum's EIPs repository.

EIP status terms