Skip to content

Update README: add ERC author checklist to reduce review overhead#1746

Open
arawrdn wants to merge 1 commit into
ethereum:masterfrom
arawrdn:master
Open

Update README: add ERC author checklist to reduce review overhead#1746
arawrdn wants to merge 1 commit into
ethereum:masterfrom
arawrdn:master

Conversation

@arawrdn
Copy link
Copy Markdown

@arawrdn arawrdn commented May 15, 2026

Hi,

Add the checklist near “Before you write an ERC”. Looks good as a docs-only refactor: it consolidates existing requirements and should cut repeat editor nit comments.

Suggested wording with a small tweak for precision:

## ERC Author Checklist

Before opening a pull request, confirm that:

- The idea has been discussed on Ethereum Magicians or Ethereum Research.
- The proposal follows the structure and requirements in EIP-1.
- The ERC targets the Ethereum application layer, not consensus-layer, networking, or interface-level changes.
- The preamble includes a valid `discussions-to` link.
- The document is written as a standard, not as an implementation support request.
- Once published at `https://eips.ethereum.org/`, the ERC uses the canonical citation format.

Why the tweak:

  • consensus-layer is clearer than just consensus.
  • not as an implementation support request reads cleaner.
  • The citation bullet avoids implying the draft must already have a published URL before opening the PR.

Good placement:

## Before you write an ERC

...

## ERC Author Checklist

...

This keeps the checklist close to the author onboarding flow without changing process rules.

Cheers,

@arawrdn arawrdn requested a review from eip-review-bot as a code owner May 15, 2026 16:21
@eip-review-bot
Copy link
Copy Markdown
Collaborator

eip-review-bot commented May 15, 2026

File README.md

Requires 2 more reviewers from @g11tech, @jochem-brouwer, @lightclient, @samwilsn, @xinbenlv

@eip-review-bot eip-review-bot changed the title docs: add ERC author checklist to reduce review overhead Update README: add ERC author checklist to reduce review overhead May 15, 2026
@github-actions
Copy link
Copy Markdown

The commit c4c7e04 (as a parent of 0094a2d) contains errors.
Please inspect the Run Summary for details.

@github-actions github-actions Bot added the w-ci label May 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants