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

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 9 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
13 changes: 12 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,18 @@ 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:

- Links in `Living`, `Meta`, or `Informational` EIPs are allowed
- Links to exact commits hosted on GitHub **MUST** be allowed if they are from one of the following repositories:
- `ethereum/EIPs`
- `ethereum/execution-specs`
- `ethereum/consensus-specs`
- Links to Ethereum Magicians **MUST** be allowed in the `discussions-to` preamble
- Links with an appropriate backup in the assets folder **MAY** be allowed
- Links to external resources **SHOULD NOT** be included if one of the above rules does not apply
Pandapip1 marked this conversation as resolved.
Show resolved Hide resolved

Pandapip1 marked this conversation as resolved.
Show resolved Hide resolved
If you feel that a link you wish to include shouldn't violate the above 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you feel that a link you wish to include shouldn't violate the above 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.

I don't think this needs saying. PRs are always welcome. Advice on what makes for a good PR applies to all of them.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PRs are always welcome.

People don't realize that. You wouldn't believe the number of comments like "why is such and such a rule a thing, I would like to change it to XYZ." People are afraid of touching things that they think are hallowed or something. Stating explicitly that it is not sacred aids in removing that barrier.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gotcha. In which case it needs saying, but as more general statement elsewhere in EIP-1. For that matter, people don't realize that they are always welcome to review PRs to any EIP.


## Linking to other EIPs

Expand Down