Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update EIP-1: Expand External Link Policy #5474

Closed
wants to merge 14 commits into from
Closed

Update EIP-1: Expand External Link Policy #5474

Changes from 13 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
87a4ceb
EIP-1 External Link Changes
Pandapip1 Aug 17, 2022
12f6f50
Define external resources
Pandapip1 Aug 17, 2022
05f57d7
Update eip-1.md
Pandapip1 Aug 17, 2022
63805dc
Make it even less ambiguous
Pandapip1 Aug 17, 2022
471367d
Unambiguify
Pandapip1 Aug 17, 2022
1cc1f62
Missed a few things
Pandapip1 Aug 17, 2022
3a1e5ec
Reformat
Pandapip1 Aug 28, 2022
8df1b66
Merge branch 'master' into patch-10
Pandapip1 Aug 28, 2022
634846f
Remove geth and expand ethereum magicians
Pandapip1 Sep 2, 2022
1c1e154
Add gcolvin rule
Pandapip1 Sep 3, 2022
6f648e0
Greatly expand the external link section
Pandapip1 Oct 5, 2022
4275965
Update it a little more
Pandapip1 Oct 5, 2022
eded28d
Add stability rules
Pandapip1 Oct 5, 2022
b26ed64
Change to recommended
Pandapip1 Oct 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 37 additions & 1 deletion EIPS/eip-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 **MUST** be non-normative.
Pandapip1 marked this conversation as resolved.
Show resolved Hide resolved
- 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/<username>/<repo>/blob/<commit_hash>/<path>`) **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

Expand Down