redhat-documentation / supplementary-style-guide

This project maintains the Red Hat supplementary style guide for product documentation that supplements the IBM Style guide
https://redhat-documentation.github.io/supplementary-style-guide/
Creative Commons Attribution Share Alike 4.0 International
34 stars 74 forks source link

add some best practices to streamline PR approval process #468

Open sbmetz opened 5 months ago

sbmetz commented 5 months ago

[Background] Since we require 3 approvals to merge an SSG change, any changes that happen after one or two approvals invalidate those approvals, effectively resetting the "clock" to 0. This can mean that early approvers may be asked to "re-approve" as additional changes are made. In general, this is appropriate -- even small late-breaking changes can be meaningful to the whole pull request. General consensus at the March 2024 style guide meeting was to not change the approval process, but we agreed that the re-approval churn can be distracting.

I am opening this issue to propose some guidelines/best practices to the admin responsibilities page.

Here are some suggestions -- please expand, add other ideas, upvote/downvote an idea (that is, chime in on what you like or don't like), suggest alternate wording, etc. The idea isn't to be overly prescriptive (there are many paths to effective collaboration), but to offer suggestions that might streamline the approval process.

bredamc commented 5 months ago

Great ideas! Thanks, @sbmetz :+1:

bredamc commented 5 months ago

Another suggestion: Create a separate Slack channel for PR approval requests, to target only those who can actually approve. Perhaps add issue discussions in that channel too.

bergerhoffer commented 5 months ago

Posted in slack, but I'd prefer not to create a separate slack channel for approvals. Other folks in the channel might actually be interested in seeing what's coming (and might want to weigh in on the discussion). We have the @ ccs-style-council slack alias for reaching just those on council who can do approvals, if needed.

Plus also that I have too many slack channels already :sweat_smile:. And I don't think there is too much activity in that channel that another channel is necessary. There are usually only a handful of threads each day, if any.

snarayan-redhat commented 3 months ago

@bergerhoffer do we have a link to the slack thread? It might be easier to keep a track of where the issue stands.

sbmetz commented 3 months ago

Here's the related slack thread: https://redhat-internal.slack.com/archives/C04HKR61MN1/p1712829051295799