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: Add adoptable field #5533

Closed
wants to merge 12 commits into from
Closed

Update EIP-1: Add adoptable field #5533

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
6ae83a8
Add adoptable field (#5463)
Pandapip1 Aug 24, 2022
2c9708a
Merge branch 'master' into adoptable
Pandapip1 Aug 26, 2022
62e7690
Merge branch 'master' into adoptable
Pandapip1 Aug 28, 2022
e8c70ab
Make defaulting to false explicit
Pandapip1 Sep 2, 2022
267d082
Set default to false
Pandapip1 Sep 2, 2022
4028447
Set adoptable to true in the template
Pandapip1 Sep 2, 2022
5761985
Merge branch 'master' into adoptable
Pandapip1 Feb 8, 2023
c3ec66e
Set default adoptable to false
Pandapip1 Apr 17, 2023
6be8d02
Wording changes
Pandapip1 Apr 17, 2023
965f114
Better logic
Pandapip1 Apr 17, 2023
0f6f1de
Fix header
Pandapip1 Apr 17, 2023
69daea3
Update eip-template.md
Pandapip1 Apr 17, 2023
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
6 changes: 6 additions & 0 deletions EIPS/eip-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,8 @@ Each EIP must begin with an [RFC 822](https://www.ietf.org/rfc/rfc822.txt) style

`withdrawal-reason`: *A sentence explaining why the EIP was withdrawn.* (Optional field, only needed when status is `Withdrawn`)

`adoptable`: *One of `true` or `false`.* (Optional field, but highly recommended to be set to `true`. Defaults to `false`)

Headers that permit lists must separate elements with commas.

Headers requiring dates will always do so in the format of ISO 8601 (yyyy-mm-dd).
Expand Down Expand Up @@ -185,6 +187,10 @@ The `created` header records the date that the EIP was assigned a number. Both h

EIPs may have a `requires` header, indicating the EIP numbers that this EIP depends on.

#### `adoptable` header

EIPs may have a `adoptable` header. If this is `true`, then any PR changing `status` from `Stagnant` to a non-final state no longer requires author approval (instead only requiring editor approval.) Marking a proposal as `adoptable` allows _anyone_ to edit the author list and take over the proposal should it become stagnant. Marking proposals as `adoptable` is recommended.

## Linking to External Resources

Links to external resources **SHOULD NOT** be included. External resources may disappear, move, or change unexpectedly.
Expand Down
1 change: 1 addition & 0 deletions eip-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ type: <Standards Track, Meta, or Informational>
category (*only required for Standards Track): <Core, Networking, Interface, or ERC>
created: <date created on, in ISO 8601 (yyyy-mm-dd) format>
requires (*optional): <EIP number(s)>
adoptable: true # It is recommended that you keep this as true. See EIP-1#adoptable-header for more information.
Copy link
Contributor

Choose a reason for hiding this comment

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

I am in favor of having an adoptable field, but I suggest keeping the template default as false until we see a trend that authors intentionally choose to flip it to true. I worry if we create a field and default to true, the new comers of EIP authors will think it's a community etiquette to sign it off. Just like the "[ ] I agree " box in many terms of services.

Suggested change
adoptable: true # It is recommended that you keep this as true. See EIP-1#adoptable-header for more information.
adoptable: false # It is recommended that you keep this as true. See EIP-1#adoptable-header for more information.

Copy link
Member

Choose a reason for hiding this comment

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

Uh, it should be etiquette. Nobody likes stagnant EIPs.

---

This is the suggested template for new EIPs.
Expand Down