EIPs icon indicating copy to clipboard operation
EIPs copied to clipboard

Published 20 hours ago • verified publisher icon ethereum

Add EIP-5976: Handbook for EIP Authors

Open xinbenlv opened this issue 2 years ago • 6 comments

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.

xinbenlv avatar Nov 15 '22 15:11 xinbenlv

Hi! I'm a bot, and I wanted to automerge your PR, but couldn't because of the following issue(s):

(fail) .github/workflows/ci.yml

classification
ambiguous
  • '.github/workflows/ci.yml' must be in eip-###.md format; this error will be overwritten upon relevant editor approval

(pass) eip-5976.md

classification
updateEIP
  • passed!

eth-bot avatar Nov 15 '22 15:11 eth-bot

This is already in the EIP template?

lightclient avatar Nov 15 '22 18:11 lightclient

This PR is not ready to review.

My intentions is to create an informational EIP not a template. I will flip to ready for review when ready.

xinbenlv avatar Nov 15 '22 18:11 xinbenlv

It would be better to only open the PR / draft once there is actually some content or explanation.

lightclient avatar Nov 15 '22 19:11 lightclient

Sounds good. Closing for now. Will reopen when ready

xinbenlv avatar Nov 15 '22 19:11 xinbenlv

@lightclient I drafted the main piece and reopen this pull request.

The motivation was that I got some good advice from you on #5875, and I want to write it down to help myself to think when authoring new opcode proposals. But in the meanwhile I realize we can use this as a handbook for other suggestions for new authors. Hence this informational EIP.

Some of the suggestions in this draft EIP are solely my personal opinion and might be wrong. Corrections and advices are greatly welcomed!

xinbenlv avatar Nov 16 '22 02:11 xinbenlv

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 Feb 16 '23 00:02 github-actions[bot]

Still WIP

xinbenlv avatar Feb 16 '23 00:02 xinbenlv

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 Mar 05 '23 00:03 github-actions[bot]

This pull request was closed due to inactivity. If you are still pursuing it, feel free to reopen it and respond to any feedback or request a review in a comment.

github-actions[bot] avatar Apr 17 '23 00:04 github-actions[bot]