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

Change the way docs approvals work #294

Merged
merged 2 commits into from
Nov 20, 2024
Merged

Change the way docs approvals work #294

merged 2 commits into from
Nov 20, 2024

Conversation

zmb3
Copy link
Contributor

@zmb3 zmb3 commented Nov 18, 2024

Docs PRs are consistently delayed due to the the fact that we currently require two approvals to come from a small team of people who are all very busy.

To mitigate this, we will treat PRs that touch docs similarly to PRs that touch code. The new behavior is:

  1. PRs continue to require two approvals, whether they touch code, docs, or both.
  2. At least one of these two approvals must come from a code "owner" (otherwise known as a "group 1 reviewer"). This becomes the case whether the PR touches docs or not.
  3. If the PR does not touch docs, then approvals from the docs reviewers don't count towards the 2 approval limit.
  4. If the PR does touch docs, then the docs reviewers are added to group 2 reviewers. Their reviews count towards the two review limit, but their reviews are not required in order to merge the PR.

@zmb3 zmb3 requested a review from a team as a code owner November 18, 2024 23:49
Docs PRs are consistently delayed due to the the fact that we currently
require two approvals to come from a small team of people who are all
very busy.

To mitigate this, we will treat PRs that touch docs similarly to PRs
that touch code. The new behavior is:

1. PRs continue to require two approvals, whether they touch code, docs,
   or both.
2. At least one of these two approvals must come from a code "owner"
   (otherwise known as a "group 1 reviewer"). This becomes the case
   whether the PR touches docs or not.
3. If the PR does not touch docs, then approvals from the docs reviewers
   don't count towards the 2 approval limit.
4. If the PR does touch docs, then the docs reviewers are added to group
   2 reviewers. Their reviews count towards the two review limit, but
   their reviews are not required in order to merge the PR.
Copy link
Contributor

@jimbishopp jimbishopp left a comment

Choose a reason for hiding this comment

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

Looks right.

bot/internal/bot/bloat.go Outdated Show resolved Hide resolved
bot/internal/review/review.go Outdated Show resolved Hide resolved
@zmb3 zmb3 merged commit cb392a5 into main Nov 20, 2024
7 checks passed
@zmb3 zmb3 deleted the zmb3/docs-reviewers branch November 20, 2024 15:37
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.

2 participants