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

Reduce team review request noise from CODEOWNERS #137

Merged
merged 2 commits into from
Feb 1, 2024

Conversation

edmorley
Copy link
Member

@edmorley edmorley commented Feb 1, 2024

The CODEOWNERS file has been adjusted to request review from the primary repository maintainer for high-traffic files that are typically updated via automation, rather than requesting review from the whole team.

This:

  • reduces team notification/review request noise for Dependabot and release automation PRs, given that other members on the team usually aren't going to look at such PRs anyway, and it only makes it harder for team members to see the review requests that are actually in their queue
  • retains the "team awareness" benefit of having the team see notifications for all other non-automated PRs
  • retains the UX benefit of having a reviewer be automatically selected

In the scenarios where either the primary repository maintainer is away, or they are the person opening the PR (so can't request review from themselves), other team members will still be able to approve the PR with the changes I've made to the branch protection settings (unchecking "Require Code Owner Review", leaving "require approvals" enabled which can only be from teams with write access, which is only us. Plus for bonus points, the option to only permit merging from members of our team has also been enabled).

For supported syntax, see:
https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

GUS-W-14941625.

The `CODEOWNERS` file has been adjusted to request review from the
primary repository maintainer for high-traffic files that are
typically updated via automation, rather than requesting review from
the whole team.

This:
- reduces team notification/review request noise for Dependabot and
  release automation PRs, given that other members on the team usually
  aren't going to look at such PRs anyway, and it only makes it harder
  for team members to see the review requests that are actually in
  their queue
- retains the "team awareness" benefit of having the team see
  notifications for all other non-automated PRs
- retains the UX benefit of having a reviewer be automatically selected

In the scenarios where either the primary repository maintainer is away,
or they are the person opening the PR (so can't request review from
themselves), other team members will still be able to approve the PR
with the changes I've made to the branch protection settings (unchecking
"Require Code Owner Review", leaving "require approvals" enabled which
can only be from teams with write access, which is only us. Plus for
bonus points, the option to only permit merging from members of our
team has also been enabled).

For supported syntax, see:
https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

GUS-W-14941625.
@edmorley edmorley self-assigned this Feb 1, 2024
@edmorley edmorley added the skip changelog Pull requests that do not require changes to the CHANGELOG file label Feb 1, 2024
@edmorley edmorley marked this pull request as ready for review February 1, 2024 15:20
@edmorley edmorley requested a review from a team as a code owner February 1, 2024 15:20
@edmorley edmorley enabled auto-merge (squash) February 1, 2024 15:20
@edmorley edmorley requested review from Malax and removed request for a team February 1, 2024 15:21
@edmorley edmorley merged commit eebcb89 into main Feb 1, 2024
5 checks passed
@edmorley edmorley deleted the edmorley/update-codeowners branch February 1, 2024 17:12
@heroku-linguist heroku-linguist bot mentioned this pull request Oct 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip changelog Pull requests that do not require changes to the CHANGELOG file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants