-
Notifications
You must be signed in to change notification settings - Fork 39
RFC: Checklists #89
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
base: main
Are you sure you want to change the base?
RFC: Checklists #89
Changes from 3 commits
a3c806e
cc3588c
602782b
ef8fa13
29a21ec
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
|
|
||
| # RPIP Status Change Checklists | ||
|
|
||
| ## Draft Checklist | ||
|
|
||
| - [ ] Ensure that the RPIP preamble is present and correctly formatted as per RPIP-1. | ||
| - [ ] Add RPIP number if not present. | ||
| - [ ] Check `title` is a few words, and not a complete sentence. | ||
| - [ ] Check `author` field matches convention. | ||
| - [ ] Check `discussions-to` field is present, and links to the Rocket Pool forum. This field should consist of a single URL. | ||
| - [ ] Check `status` is set to 'Draft' | ||
| - [ ] Check that `type` is a valid value. | ||
| - [ ] If the `type` is 'protocol', ensure a `category` is present. | ||
| - [ ] Check that `created` is set to the day of the RPIP number assignment, in the YYYY-MM-DD format. | ||
| - [ ] Ensure that the RPIP matches the RPIP template in terms of layout. | ||
LongForWisdom marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - [ ] Ensure that the RPIP author is content with the draft being published on the RPIPs portal in its current state. | ||
|
|
||
| ## Finalize Checklist | ||
| - [ ] Ensure that the RPIP Draft Checklist has been completed for this RPIP. | ||
| - [ ] Ensure that the RPIP preamble is present and correctly formatted for a finalized RPIP. | ||
| - [ ] Check `status` is set to 'Final' | ||
| - [ ] Ensure that the finalization PR is the only open pull request modifying the RPIP in the official RPIP repository. | ||
LongForWisdom marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - [ ] Editor Responsibilities | ||
| - [ ] Check that the RPIP is ready, sound and complete. | ||
| - [ ] Check that the ideas within the RPIP make technical sense. | ||
| - [ ] Check that the RPIP title accurately describes the RPIP content. | ||
| - [ ] Check the RPIP for language, markup, and code style. | ||
LongForWisdom marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - [ ] Ensure that the RPIP author has confirmed the RPIP is ready to be finalized. | ||
| - [ ] Ensure that the RPIP editors have confirmed the RPIP is ready to be finalized. | ||
|
|
||
| ## Withdrawn Checklist | ||
| - [ ] Ensure that the RPIP author has confirmed that they are withdrawing the RPIP. | ||
| - [ ] Check `status` is set to 'Withdrawn' | ||
|
|
||
| ## Stagnant Checklist | ||
| - [ ] Ensure that RPIP editors are in general agreement that the RPIP has been inactive for too long. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Worth adding time guidance here? I think it will be situational (some RPIPs might be drafted toward timely items), but having something like
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this is more a checklist for after a stagnant RPIP has been identified? I could make a general 'RPIP weekly update checklist' to contain stuff like: 'check for stagnant RPIPs' Would this be useful to the editors? |
||
| - [ ] Attempt to confirm the status change with the author if they are still a regular in the Rocket Pool community. | ||
| - [ ] Check `status` is set to 'Stagnant' | ||
|
|
||
| ## Living Update Checklist | ||
| - [ ] Check `status` is set to 'Living' | ||
| - [ ] Add or update the `updated` date field in the format of YYYY-MM-DD. | ||
| - [ ] Confirm any associated content changes with the other RPIP editors. | ||
|
|
||
| ## Vote Update Checklist | ||
| - [ ] Add or update the `vote-to` field. The value should be a URL pointing to the outcome of the vote. | ||
| - [ ] Add or update the `vote-date` field. The date should be in YYYY-MM-DD format, and should match the date the vote concluded. | ||
| - [ ] Add the `vote-result` field. This should be the vote result: 'Passed' or 'Failed' | ||
| - [ ] This field should not be updated to 'Failed' for Living RPIPs that have previously had successful votes. | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
|
|
||
| # Rocket Pool Vote Checklist | ||
|
|
||
| ## If vote has attached RPIP | ||
| - [ ] The RPIP is present in the RPIP github repository. | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "GitHub"? |
||
| - [ ] The RPIP Draft Checklist has been completed for this RPIP. | ||
| - [ ] RPIP has been given `final` status in the main branch of the official RPIP repository. | ||
| - [ ] The RPIP Finalize Checklist has been completed for this RPIP. | ||
LongForWisdom marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## Always | ||
| - [ ] The vote has met the requirement for 'promising community sentiment' | ||
| - Usually demonstrated by a poll on the RP forum that is open for at least 7 days. | ||
| - [ ] Vote text has been completed for this vote. | ||
| - [ ] The Vote Text checklist has been completed for the final iteration of the vote text. | ||
| - [ ] Think about this vote for five minutes by the clock. Attempt to confirm that what you're doing makes sense. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
|
|
||
| # Rocket Pool Vote Text Checklist | ||
LongForWisdom marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| - [ ] Vote text should include the following: | ||
| - [ ] A short one-line summary intended to display effectively on the snapshot vote-listing page. | ||
| - [ ] Context as to the reason for the vote. | ||
| - [ ] A clear and concrete explanation of the possible outcomes of the voting process. | ||
| - [ ] Links to relevant resources or further context. | ||
| - [ ] A link to a relevant discussion thread on the Rocket Pool forums. | ||
| - [ ] Ensure that all URLs point to the intended destinations. | ||
| - [ ] The issue of framing bias has been considered and mitigated where possible. | ||
LongForWisdom marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - [ ] RPIP Editors have reviewed vote text. | ||
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.
could you just list the valid values here?