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.

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
9 changes: 9 additions & 0 deletions EIPS/eip-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,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`: *Adoptability options. See description below.* (Optional field, but highly recommended to be set to `any`. 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 @@ -188,6 +190,13 @@ EIPs may have a `requires` header, indicating the EIP numbers that this EIP depe

A `requires` dependency is created when the current EIP cannot be understood or implemented without a concept or technical element from another EIP. Merely mentioning another EIP does not necessarily create such a dependency.

#### `adoptable` header

EIPs may have a `adoptable` header. There are a two options available:

- `false`: No changes.
- `any`: If the EIP stagnantes, any individual can choose to champion the EIP, subject to the approval of an editor. Specifically, this permits any editor to merge a pull request submitted by any other person, so long as that pull request only changes a proposal's `status` header from `Stagnant` to `Draft`, and appends the individual's name as a co-author, and as long as that proposal has `adoptable: any` set.

## Linking to External Resources

Other than the specific exceptions listed below, links to external resources **SHOULD NOT** be included. External resources may disappear, move, or change unexpectedly.
Expand Down
3 changes: 2 additions & 1 deletion eip-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ status: Draft
type: <Standards Track, Meta, or Informational>
category: <Core, Networking, Interface, or ERC> # Only required for Standards Track. Otherwise, remove this field.
created: <date created on, in ISO 8601 (yyyy-mm-dd) format>
requires: <EIP number(s)> # Only required when you reference an EIP in the `Specification` section. Otherwise, remove this field.
requires: <EIP number(s)> # Only required when you reference an EIP in the `Specification` section. Otherwise, remove this field.
adoptable: false # Setting this to `any` allows editors to select a new champion if the proposal stagnates.
---

<!--
Expand Down