COMMUNITY-ROLES: streamline the How-to section #2881
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Use preformatted blocks for the message templates (instead of quote blocks, which required escaping of markdown formatting, yet still didn't prevent "smart" links from being rendered by github). - Use a numbered list to make the role change processes easier to follow. - Emphasize that the messages are templates, which should be edited if needed. - Change 1 week to 2 weeks of when removing inactive owners. (to allow for periods of unavailability, illness, personal reasons, etc.) - Correct references to "below" to point to MAINTAINERS.md instead. - Add the step to update MAINTAINERS.md to all role change checklists. - Add the step to close the issue (only when all the previous steps are completed) to all role change checklists.
waldyrious
added
community
Mention that a PR should be created for the MAINTAINERS.md updates, which then can automatically close the issue, thereby making step 4 obsolete.
Closed
mebeim
reviewed
Apr 9, 2019
sbrl
approved these changes
Apr 10, 2019
There was a problem hiding this comment.
Looks ok to me after @mebeim's comments are addressed. Thanks again, @waldyrious 😺
- Remove "For" at the start of the headings of the how-to sections - Remove colons at the end of two of the section headings, for consistency - Clarify that consent must be given for the procedures to advance
|
Thanks for the suggestions @mebeim! I've applied them, please take another look when you can. |
|
@mebeim I just realized that the template messages leave no room for the recipient to accept or decline the proposal 😄 Oh well, another update is in order... |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Looks like every time we make role changes new wrinkles are found in the process description :)
In this case, #2874 was closed with no mention of MAINTAINERS.md needing an update
(it was actually done in #2746, but without a backlink to the issue). Actually, my bad -- the update was not done after all, that was the older change from when he became a collaborator. More evidence that the process was missing steps :)While on it, I also made some formatting changes and assorted adjustments to streamline the process. Here is the full list of changes:
(instead of quote blocks, which required escaping of markdown formatting,
yet still didn't prevent "smart" links from being rendered by github).
(to allow for periods of unavailability, illness, personal reasons, etc.)