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

Add EIP-5069: EIP editor handbook in EIP form #5069

Merged
merged 29 commits into from
Jun 28, 2022
Merged

Add EIP-5069: EIP editor handbook in EIP form #5069

merged 29 commits into from
Jun 28, 2022

Conversation

Pandapip1
Copy link
Member

@Pandapip1 Pandapip1 commented May 2, 2022

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:

  • Threshold for terminal stagnant status (arbitrarily chosen as 6 months pending further discussion)
  • Determine whether the EIP should be Meta or Informational
  • Permission to use external links to @SamWilsn's PRs as examples
  • Permission to use external links to the EIPIP repository
  • Does this EIP really need security considerations and a backward compatibility section?
  • Can this be merged as "Living"?

Fixes #5048

@eth-bot
Copy link
Collaborator

eth-bot commented May 2, 2022

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

classification
updateEIP

(fail) eip-5069.md

classification
newEIPFile

(fail) README.md

classification
ambiguous
  • 'README.md' must be in eip-###.md format; this error will be overwritten upon relevant editor approval

@Pandapip1 Pandapip1 changed the title EIP editor apprentice handbook -- in EIP form PR-5069: EIP editor apprentice handbook in EIP form May 2, 2022
@Pandapip1 Pandapip1 changed the title PR-5069: EIP editor apprentice handbook in EIP form EIP-5069: EIP editor apprentice handbook in EIP form May 2, 2022
@poojaranjan
Copy link
Contributor

Thanks for adding this to EIPIP meeting agenda. Hope to hear thoughts of EIP editors.

EIPS/eip-5069.md Outdated Show resolved Hide resolved
EIPS/eip-5069.md Outdated Show resolved Hide resolved
EIPS/eip-5069.md Outdated Show resolved Hide resolved
Pandapip1 and others added 3 commits May 3, 2022 06:39
Co-authored-by: Andrew B Coathup <[email protected]>
Co-authored-by: Andrew B Coathup <[email protected]>
Co-authored-by: Andrew B Coathup <[email protected]>
@Pandapip1
Copy link
Member Author

Thank you!

@Pandapip1
Copy link
Member Author

CC'ing @MicahZoltu as the primary "No External Links" enforcer. Which of the following am I allowed to link to?

  • Sam's editor PR
  • EIPIP repository
  • (maybe) EIP insights
  • (maybe) PEEPanEIP

Copy link
Member

@lightclient lightclient left a 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.

EIPS/eip-5069.md Outdated Show resolved Hide resolved
EIPS/eip-5069.md Outdated Show resolved Hide resolved
EIPS/eip-5069.md Show resolved Hide resolved
Copy link
Member

@lightclient lightclient left a 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.

@Pandapip1
Copy link
Member Author

That was my original intent. I'll do that now.

@Pandapip1 Pandapip1 changed the title EIP-5069: EIP editor apprentice handbook in EIP form EIP-5069: EIP editor handbook in EIP form May 31, 2022
Copy link
Contributor

@SamWilsn SamWilsn left a 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...

EIPS/eip-5069.md Outdated Show resolved Hide resolved
EIPS/eip-5069.md Outdated Show resolved Hide resolved
EIPS/eip-5069.md Outdated Show resolved Hide resolved
EIPS/eip-5069.md Outdated Show resolved Hide resolved
EIPS/eip-5069.md Outdated Show resolved Hide resolved
@Pandapip1 Pandapip1 marked this pull request as draft June 14, 2022 11:30
@Pandapip1
Copy link
Member Author

Moving this PR into draft in case it auto-merges now.

@SamWilsn
Copy link
Contributor

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.

@Pandapip1 Pandapip1 closed this Jun 18, 2022
@Pandapip1 Pandapip1 reopened this Jun 18, 2022
@Pandapip1 Pandapip1 marked this pull request as ready for review June 18, 2022 12:16
Copy link
Member

@lightclient lightclient left a comment

Choose a reason for hiding this comment

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

Cool, LGTM.

Copy link
Member

@lightclient lightclient left a comment

Choose a reason for hiding this comment

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

test

Copy link
Member

@lightclient lightclient left a comment

Choose a reason for hiding this comment

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

LGMT

@lightclient lightclient merged commit 3788a5c into ethereum:master Jun 28, 2022
@Pandapip1 Pandapip1 deleted the patch-9 branch June 29, 2022 19:03
@Pandapip1 Pandapip1 changed the title EIP-5069: EIP editor handbook in EIP form Add EIP-5069: EIP editor handbook in EIP form Oct 11, 2022
nachomazzara pushed a commit to nachomazzara/EIPs that referenced this pull request Jan 13, 2023
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.

Formalize EIP Editor Apprentice Project
8 participants