-
Notifications
You must be signed in to change notification settings - Fork 5.4k
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
Add EIP-5069: EIP editor handbook in EIP form #5069
Conversation
Hi! I'm a bot, and I wanted to automerge your PR, but couldn't because of the following issue(s): (fail) eip-1.md
(fail) eip-5069.md
(fail) README.md
|
Thanks for adding this to EIPIP meeting agenda. Hope to hear thoughts of EIP editors. |
Co-authored-by: Andrew B Coathup <[email protected]>
Co-authored-by: Andrew B Coathup <[email protected]>
Co-authored-by: Andrew B Coathup <[email protected]>
Thank you! |
CC'ing @MicahZoltu as the primary "No External Links" enforcer. Which of the following am I allowed to link to?
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is a good idea. I feel like the framing might be slightly wrong here though -- this is really an EIP Editors handbook, with a section on how to become an editor. Much of the content is just best practices for being an editor. I think it would be useful to contemplate how to structure this so that it is more i) more like a guide to what/how and EIP Editor edits ii) avoid duplication with EIP-1. I still think EIP-1 should stand on it's own as a document that explains exactly how an EIP should be structure, so we need to be careful to not have "special rules" in this EIP.
Co-authored-by: lightclient <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's best to drop the "apprentice" term from the EIP and focus on this EIP being a guide to being an editor in general. E.g. how one becomes and editor, certain stylistic rules editors try to enforce to meet EIP-1, etc.
That was my original intent. I'll do that now. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall I think this is a good idea, but I don't think it should follow the format laid out in EIP-1. It just doesn't really make sense to write this as a specification...
Co-authored-by: Sam Wilson <[email protected]>
Moving this PR into draft in case it auto-merges now. |
I like where this is going, and would be happy to see it evolve over time. 👍 to merge. After we get the initial version in, I think we can loosen up the format since it really isn't a specification. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool, LGTM.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
test
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGMT
CC: @poojaranjan
I've heavily modified https://hackmd.io/@poojaranjan/EIP-ERC-Editor-handbook to suit the EIP format and to make the document more formal, specific, inclusive, and easier to understand.
Notes to EIP-1 and the README are added to increase awareness.
Items that need discussion:
Fixes #5048