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

PHEP 2: PHEP template #25

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

jtniehof
Copy link
Contributor

@jtniehof jtniehof commented Nov 27, 2023

This is a template following the format requirements of PHEP 1 (#22) with the intention of making it easier to copy/paste into starting a new PHEP.

The template does mix directions on what to do, the PHEP-required content of PHEP 2 itself, and the content to be filled in on the new PHEP. I hope that's not too unclear--we could try, say, italicizing everything to make it clear if someone using the template leaves in template language, but that doesn't solve the problem of distinguishing the rest. Maybe it's perfectly clear to the reader.

@jtniehof
Copy link
Contributor Author

@sapols , hoping I can ask you to serve as editor again :) In particular I didn't want to just "steal" number 2...gotta do these things right.

My thought is to edit and force push once the number is assigned. I think this makes the history more clear, and I can update PHEP 1 to explicitly say force-push is okay while the PR is in draft (not the same as the PHEP being in draft!)--it makes it easier to track the filename.

@sapols
Copy link
Contributor

sapols commented Nov 29, 2023

Phenomenal template. Love it.

@sapols sapols self-requested a review November 29, 2023 20:18
@jtniehof
Copy link
Contributor Author

Phenomenal template. Love it.

Good for me to self-assign PHEP 2 and non-draft, or do you need further format/compliance review?

@sapols
Copy link
Contributor

sapols commented Dec 4, 2023

Good for me to self-assign PHEP 2 and non-draft, or do you need further format/compliance review?

I could use a bit longer to re-read it one last time, closer.

pheps/phep-9999.md Outdated Show resolved Hide resolved
pheps/phep-9999.md Outdated Show resolved Hide resolved
pheps/phep-9999.md Outdated Show resolved Hide resolved
Copy link
Contributor

@sapols sapols left a comment

Choose a reason for hiding this comment

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

Literally my only request is to add those periods to the ends of those list items for consistency. Otherwise I approve this template.

@jtniehof feel free to self-assign PHEP-2 and non-draft once these changes are made.

@jtniehof jtniehof changed the title PHEP ?: PHEP template PHEP 2: PHEP template Dec 6, 2023
@jtniehof jtniehof marked this pull request as ready for review December 6, 2023 21:40
@jtniehof
Copy link
Contributor Author

jtniehof commented Dec 6, 2023

Literally my only request is to add those periods to the ends of those list items for consistency. Otherwise I approve this template.

Done, and thanks!

@jibarnum jibarnum self-requested a review December 7, 2023 03:15
@jibarnum jibarnum removed their request for review December 7, 2023 04:22
@jibarnum
Copy link

jibarnum commented Dec 7, 2023

Didn't mean to add myself as an official reviewer on this. @sapols 's got the ultimate approval as editor on this PHEP, but I'm throwing support behind the comment he made :

Phenomenal template. Love it.

@jtniehof
Copy link
Contributor Author

jtniehof commented Dec 7, 2023

Didn't mean to add myself as an official reviewer on this. @sapols 's got the ultimate approval as editor on this PHEP, but I'm throwing support behind the comment he made :

Anybody can do a GH "review" of the PR to give their feedback, so no problem. The editorial decision is just at assigning a number and going from draft to "ready for review".

@jtniehof
Copy link
Contributor Author

New version pushed largely reflecting the revision process in PHEP 1 (#22)

@jtniehof
Copy link
Contributor Author

@sapols, do you have any suggestions for this from experience with #29 ? Otherwise I will ask Julie to put the first vote on the telecon schedule.

@sapols
Copy link
Contributor

sapols commented Jun 11, 2024

@jtniehof I found it great to use, no notes! I second moving to vote as-is.

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.

None yet

3 participants