EIPs icon indicating copy to clipboard operation
EIPs copied to clipboard

Update EIP template: Remove non-required fields and add acceptable placeholders

Open Pandapip1 opened this issue 3 years ago • 5 comments
trafficstars

  • Removes the eip preamble field from the template. Editors can simply add it themselves.
  • Moves the asterisks in the preamble fields to comments
  • Moves all the instructions to HTML comments
  • Adds a note to read EIP-1 before making an EIP
  • Removes Motivation, Reference Implementation, and Test Cases sections
  • Adds placeholders to Rationale, Backwards Compatibility, and Security considerations
  • Removes an external link

Pandapip1 avatar Sep 02 '22 12:09 Pandapip1

All tests passed; auto-merging...

(pass) eip-template.md

classification
ambiguous
  • file eip-template.md is not a valid filename, but this error has been ignored due to editor approvals

(pass) index.html

classification
ambiguous
  • file index.html is not a valid filename, but this error has been ignored due to editor approvals

eth-bot avatar Sep 02 '22 12:09 eth-bot

I'm worried we'll get a ton of EIPs that have the comments left in with this :rofl:

I do appreciate moving the optional bits after the colon in the preamble though.

SamWilsn avatar Sep 16 '22 21:09 SamWilsn

I'm worried we'll get a ton of EIPs that have the comments left in with this 🤣

We do anyways. I'd say a good 1/8 of incoming drafts have at least one of the sections left unchanged or the bit before the abstract not removed - typically the rationale, backwards compatibility, or security considerations section.

Pandapip1 avatar Sep 18 '22 17:09 Pandapip1

That's fair. Perhaps a lint for HTML style comments in eipw would help.

SamWilsn avatar Sep 30 '22 19:09 SamWilsn

That's fair. Perhaps a lint for HTML-style comments in eipw would help.

Go ahead -- be warned that some people use them to indicate TODOs.

Pandapip1 avatar Oct 02 '22 12:10 Pandapip1

There has been no activity on this pull request for 2 weeks. It will be closed after 3 months of inactivity. If you would like to move this PR forward, please respond to any outstanding feedback or add a comment indicating that you have addressed all required feedback and are ready for a review.

github-actions[bot] avatar Nov 22 '22 00:11 github-actions[bot]

Not stale.

Pandapip1 avatar Nov 22 '22 18:11 Pandapip1

Can we separate this into two PRs: one to put the instructions in comments, and then a second to remove the optional sections? I am in favour of the first, and against the second.

SamWilsn avatar Nov 25 '22 18:11 SamWilsn

@SamWilsn your concerns have been addressed.

Pandapip1 avatar Nov 28 '22 17:11 Pandapip1

There has been no activity on this pull request for 2 weeks. It will be closed after 3 months of inactivity. If you would like to move this PR forward, please respond to any outstanding feedback or add a comment indicating that you have addressed all required feedback and are ready for a review.

github-actions[bot] avatar Dec 13 '22 00:12 github-actions[bot]

@SamWilsn mind re-reviewing?

Pandapip1 avatar Dec 13 '22 01:12 Pandapip1

Oh sorry, I have notifications off for this repo. Feel free to ping me directly if you need me!

SamWilsn avatar Dec 16 '22 20:12 SamWilsn

There has been no activity on this pull request for 2 weeks. It will be closed after 3 months of inactivity. If you would like to move this PR forward, please respond to any outstanding feedback or add a comment indicating that you have addressed all required feedback and are ready for a review.

github-actions[bot] avatar Jan 05 '23 00:01 github-actions[bot]

@SamWilsn this is ready for review again.

Pandapip1 avatar Jan 05 '23 18:01 Pandapip1

There has been no activity on this pull request for 2 weeks. It will be closed after 3 months of inactivity. If you would like to move this PR forward, please respond to any outstanding feedback or add a comment indicating that you have addressed all required feedback and are ready for a review.

github-actions[bot] avatar Jan 20 '23 00:01 github-actions[bot]

Still would like this.

Pandapip1 avatar Jan 20 '23 14:01 Pandapip1

The commit 0ce90344a1eeba69ddaaa2722e912fae20d5aa63 (as a parent of d14c7351aa8dff5abe7633041874712358371a8b) contains errors. Please inspect the Run Summary for details.

github-actions[bot] avatar Jan 25 '23 18:01 github-actions[bot]

test

on-theway avatar Feb 22 '24 04:02 on-theway