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: Remove eip preamble entry #6790

Closed
wants to merge 1 commit into from
Closed

Conversation

Pandapip1
Copy link
Member

@Pandapip1 Pandapip1 commented Mar 27, 2023

Nothing really depends on the EIP number being in the preamble anymore, so we can safely remove it.

@Pandapip1 Pandapip1 requested a review from eth-bot as a code owner March 27, 2023 14:43
@github-actions github-actions bot added c-update Modifies an existing proposal t-process labels Mar 27, 2023
@eth-bot
Copy link
Collaborator

eth-bot commented Mar 28, 2023

File EIPS/eip-1.md

Requires 2 more reviewers from @axic, @gcolvin, @lightclient, @SamWilsn

@eth-bot eth-bot changed the title Remove eip preamble entry Update EIP-1: Remove eip preamble entry Mar 28, 2023
@eth-bot eth-bot added the e-consensus Waiting on editor consensus label Mar 28, 2023
@abcoathup
Copy link
Contributor

Nothing really depends on the EIP number being in the preamble anymore, so we can safely remove it.

Where is the EIP number specified if not in the preamble? Is it in the filename?

@Pandapip1
Copy link
Member Author

Is it in the filename?

Yes.

@lightclient
Copy link
Member

There is no need to remove the eip from the preamble.

@Pandapip1
Copy link
Member Author

Pandapip1 commented Mar 29, 2023

There is no need to remove the eip from the preamble.

Actually, it makes eip-review-bot slightly simpler, and also removes redundant information. So my stance is 'there is no need to keep the eip in the preamble.'

@SamWilsn
Copy link
Contributor

I'm generally in favour of single-sourcing information as much as possible, so in this case I'd lean towards removing eip: from the preamble.

@lightclient are there any scenarios where removing the header is problematic?

@lightclient
Copy link
Member

It's a long standing piece of the preamble. I think it is a unique piece of the EIP process and I would be sad to see it go. I would rather increase the complexity of the bots to deal with it than remove it. However, it's not something I feel terribly strongly about. What I do feel strongly about is the constant change in the repository. Things like this are marginal improvements that will likely cause more confusion to authors than do good in the short term.

I think it is time to start make changes at more spaced intervals and batching many of these changes together at once.

@Pandapip1
Copy link
Member Author

What I do feel strongly about is the constant change in the repository.

Would you mind explaining what exactly you dislike about continuous improvement? How would batching changes address those concerns?

@lightclient
Copy link
Member

The vast majority of contributors to this repository only do so occasionally. I am messaged frequently about "why is this like this now" and "when did this requirement get added / go away". If software is expected to batch breaking changes into major release, it should go doubly so for processes IMO.

@SamWilsn
Copy link
Contributor

I don't think it significantly increases the technical complexity of the bots to include the EIP number in the preamble. We'd just need to figure out exactly how it should work.

On the eipw side:

  1. If the filename matches eip-[0-9]+\.md:
    • The eip: header must exist.
    • The eip: header must match the filename.
  2. If the filename doesn't match eip-[0-9]+\.md:
    • The filename must match the title header, with underscores.
    • The status must be Draft.
    • The eip header must not exist.

Sound right?

@Pandapip1
Copy link
Member Author

Nope, I think that the eip header shouldn't exist, ever.

@Pandapip1
Copy link
Member Author

If software is expected to batch breaking changes into major release, it should go doubly so for processes IMO.

How about versioned processes? So that older EIPs can get "grandfathered" and use older formatting/rules?

@xinbenlv
Copy link
Contributor

xinbenlv commented Apr 3, 2023

My position is against of removing EIP number in preamble in the content.

Reason: the piece of information "number" is important enough to be replicated in the content and hence could be double checked, carried in publication, spread etc.

@lightclient
Copy link
Member

Closing as there wasn't sufficient support in the EIPIP meeting.

@lightclient lightclient closed this Apr 5, 2023
@Pandapip1 Pandapip1 deleted the Pandapip1-patch-14 branch October 27, 2023 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c-update Modifies an existing proposal e-consensus Waiting on editor consensus t-process
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants