diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index a2e6d239720c4c..7c1199029f335f 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -187,7 +187,43 @@ EIPs may have a `requires` header, indicating the EIP numbers that this EIP depe ## Linking to External Resources -Links to external resources **SHOULD NOT** be included. External resources may disappear, move, or change unexpectedly. +External resources are resources that are hosted outside of the EIPs repository. External resources may disappear, move, or change unexpectedly. The following rules apply in order. + +If you feel that a link you wish to include shouldn't violate the below rules, please submit a Pull Request to change them. Remember that the smaller and more specific the change, the more likely it will be accepted. + +### Access Rules + +- All external resources **MUST** be free to both access and distribute. +- All external resources **MUST** use one of the following whitelisted URI schemes: + - `https` + - `ipfs` + +### Reference Rules + +- All external resources are **RECOMMENDED** to be non-normative. +- All external resources **MUST** be cited. + - For example, [Welch, T., "A Technique for High-Performance Data Compression", IEEE Computer 17(6), DOI 10.1109/MC.1984.1659158, June 1984](https://ieeexplore.ieee.org/document/1659158). + +### Permanence Rules + +- Ethereum Magicians **MUST** be allowed in the `discussions-to` preamble entry. +- All links whose hostname is included in the following list and whose URI scheme is `https` **MUST** be allowed: + - `doi.org` + - `chainagnostic.org` + - `rfc-editor.org` or `www.rfc-editor.org` +- All links to exact commits hosted on GitHub (of the format `https://github.com///blob//`) **MUST** be allowed if they are from one of the following repositories: + - `bitcoin/bips` + - `ethereum/EIPs` + - `ethereum/execution-specs` + - `ethereum/consensus-specs` +- Links with an appropriate backup in the assets folder **MAY** be allowed. +- All links in `Living`, `Meta`, or `Informational` EIPs **MUST** be allowed. + - It is still **RECOMMENDED** to add a backup. + +### Fallback +- Links should be the most stable (i.e., unlikely to change and expected to be continuously available) and direct reference possible. +- The International DOI Foundation maintains the [Digital Object Identifier Service](https://www.doi.org) as an online registry of stable, indirect links. DOI numbers should be included in citations when available. +- All other external resources **MUST NOT** be included. ## Linking to other EIPs