Skip to content

Apply fixes suggested by Manu#2

Open
Madib036 wants to merge 1 commit into
masterfrom
manu-fixes
Open

Apply fixes suggested by Manu#2
Madib036 wants to merge 1 commit into
masterfrom
manu-fixes

Conversation

@Madib036

@Madib036 Madib036 commented May 20, 2026

Copy link
Copy Markdown
Owner

ATTENTION: ERC-RELATED PULL REQUESTS NOW OCCUR IN ETHEREUM/ERCS

--

When opening a pull request to submit a new EIP, please use the suggested template: https://github.com/ethereum/EIPs/blob/master/eip-template.md

We have a GitHub bot that automatically merges some PRs. It will merge yours immediately if certain criteria are met:

  • The PR edits only existing draft PRs.
  • The build passes.
  • Your GitHub username or email address is listed in the 'author' header of all affected PRs, inside .
  • If matching on email address, the email address is the one publicly listed on your GitHub profile.

Summary by CodeRabbit

  • Documentation
    • Clarified Ethereum Improvement Proposal (EIP) process guidelines with standardized terminology and definitions
    • Enhanced submission checklists and specification requirements, including updated platform references
    • Refined status transition workflows and clarified editor responsibilities and ownership procedures
    • Updated header preamble instructions with improved reference formatting standards
    • Improved overall documentation structure for better consistency and accessibility

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 20, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

EIP-1 governance documentation receives a comprehensive update: capitalization standardized across role references (EIP Author/Editor), EIP Types section reorganized with expanded Standards Track guidance, shepherding workflow clarified with explicit warnings on contentious issues, implementation platform requirements expanded, editor responsibilities restructured, and obsolete specification testing subsection removed.

Changes

EIP-1 Governance and Process Documentation

Layer / File(s) Summary
Core EIP Definition and Types
EIPS/eip-1.md
Introductory EIP definition capitalization corrected; EIP Types section comprehensively reworked with revised Standards Track description, reordered Informational and Meta bullets, and adjusted Core category examples.
EIP Shepherding and Process Status Flow
EIPS/eip-1.md
Shepherding workflow language updated with clarified author guidance; new warning paragraph added about contentious non-technical issues in Core EIP guidance; Last Call to Final status descriptions revised with clarified PR content requirements.
Successful EIP Requirements and Format
EIPS/eip-1.md
"What belongs in a successful EIP" checklist rephrased; Specification bullet's platform list expanded to include reth; RFC 822 reference styling updated in Header Preamble section.
External Linking Rules Update
EIPS/eip-1.md
Entire "Execution Client Specification Tests" subsection removed from external-linking rules, including example links and URL regex patterns.
EIP Editor Role and Responsibilities
EIPS/eip-1.md
Auxiliary Files and EIP Editors sections reformatted; new directive added for aspiring editors pointing to EIP-5069; editor responsibilities section reworded with structured workflow steps; history attribution updated with RFC reference definition.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

A document refined with care,
Where Authors now wear Caps to spare,
Editors grow reth-wise and true,
Process flows both clear and new,
The EIP path shines bright and fair. 🐰✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Apply fixes suggested by Manu' is vague and lacks specific detail about the actual changes made to the codebase. Consider a more descriptive title that highlights the specific changes, such as 'Update EIP-1 documentation: correct capitalization and refine process guidelines' to clearly communicate the main modifications.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch manu-fixes
⚔️ Resolve merge conflicts
  • Resolve merge conflict in branch manu-fixes

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@EIPS/eip-1.md`:
- Line 102: Replace occurrences of "RFC 822" in the EIP header/preamble text
with "RFC 5322" (or "RFC 822 style (RFC 5322)" if you want the historical note)
— specifically update the string "Preamble - [RFC 822] style headers..." and the
other two places that reference RFC 822 (including the link reference) so they
point to or cite RFC 5322 as the current standard; ensure the link target and
display text reflect RFC 5322 accordingly.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 511e4e29-cbde-4c18-9e17-2243da1134c5

📥 Commits

Reviewing files that changed from the base of the PR and between 64d1b46 and bbd91fe.

📒 Files selected for processing (1)
  • EIPS/eip-1.md

Comment thread EIPS/eip-1.md
Each EIP should have the following parts:

- Preamble - RFC 822 style headers containing metadata about the EIP, including the EIP number, a short descriptive title (limited to a maximum of 44 characters), a description (limited to a maximum of 140 characters), and the author details. Irrespective of the category, the title and description should not include EIP number. See [below](./eip-1.md#eip-header-preamble) for details.
- Preamble - [RFC 822] style headers containing metadata about the EIP, including the EIP number, a short descriptive title (limited to a maximum of 44 characters), a description (limited to a maximum of 140 characters), and the author details. Irrespective of the category, the title and description should not include EIP number. See [below](./eip-1.md#eip-header-preamble) for details.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🌐 Web query:

What is the current RFC standard for email message format headers that obsoleted RFC 822?

💡 Result:

RFC 822 was originally superseded by RFC 2822, which was subsequently obsoleted by RFC 5322, Internet Message Format [1][2][3]. RFC 5322 is the current authoritative standard for the format of text messages sent between computer users, including email message headers [1].

Citations:


Update RFC 822 reference to RFC 5322.

RFC 822 was obsoleted by RFC 2822 and subsequently by RFC 5322 (October 2008), which is the current authoritative standard for Internet Message Format and email message headers. Update lines 102, 119, and the link reference at lines 583-584 to use RFC 5322 instead, or use "RFC 822 style (RFC 5322)" if historical terminology is intentional.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@EIPS/eip-1.md` at line 102, Replace occurrences of "RFC 822" in the EIP
header/preamble text with "RFC 5322" (or "RFC 822 style (RFC 5322)" if you want
the historical note) — specifically update the string "Preamble - [RFC 822]
style headers..." and the other two places that reference RFC 822 (including the
link reference) so they point to or cite RFC 5322 as the current standard;
ensure the link target and display text reflect RFC 5322 accordingly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants