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 3 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
9 changes: 8 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,14 @@ 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. Links to external resources **MUST NOT** be included, except in `Living`, `Meta`, or `Informational` EIPs. External resources may disappear, move, or change unexpectedly.
Copy link
Contributor

@xinbenlv xinbenlv Aug 17, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
External resources are resources that are hosted outside of the EIPs repository. Links to external resources **MUST NOT** be included, except in `Living`, `Meta`, or `Informational` EIPs. External resources may disappear, move, or change unexpectedly.
Links to external resources **SHOULD NOT** be included without justification over and mitigation against the following caveats:
1. External resources may disappear, move, or change unexpectedly. Therefore, EIP should choose permlink or archive link over transient links/
2. EIP is not meant for project-promotional purpose. Links to reference implementations or mentioning of projects outside of @ethereum org's repo **MUST** be justified based on merit by a consensus amongst the editor group.


The following **MAY** be allowed at editor discretion:
Pandapip1 marked this conversation as resolved.
Show resolved Hide resolved

- Links to `ethereum/go-ethereum` commits
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
- Links to `ethereum/go-ethereum` commits
- Links to **ANY** `ethereum/<repo>` permlinks

Copy link
Member Author

@Pandapip1 Pandapip1 Aug 17, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

No. You want a new repo? Submit a PR changing EIP-1.

- Links to `ethereum/execution-specs` commits
- Links to `ethereum/consensus-specs` commits
- Resources with an appropriate backup in the assets folder
Copy link
Contributor

@xinbenlv xinbenlv Aug 17, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
- Resources with an appropriate backup in the assets folder
- Links to permlinks in any standard body that exists over 10 years, such as IETF, ISO, NIST, W3C,...
- Resources with an appropriate backup in the assets folder

Copy link
Member Author

Choose a reason for hiding this comment

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

This is outside the scope of this PR.


## Linking to other EIPs

Expand Down