Skip to content

Code Owners Configuration and PR Review Notification Settings

Jump to bottom
Muneeb Zia edited this page Sep 27, 2024 · 7 revisions

Overview

In this guide, we will cover how to configure Code Owners in agoric-sdk repository to allow external contributors to request reviews for pull requests (PRs) but not approve them. This setup is essential for maintaining a high level of code quality and ensuring that the right people are reviewing contributions. Additionally, Code Owners help external collaborators contribute effectively while adhering to project standards.

❓ Why Use Code Owners?

Implementing Code Owners provides several key benefits:

  • Ensures code quality: Code Owners can ensure that only approved changes from trusted reviewers are merged into the repository.
  • Streamlines collaboration: External contributors can confidently open PRs, knowing that the right team will be notified for a review.
  • Automates reviews: When a Code Owner is defined for specific parts of the repository, GitHub will automatically request reviews from the right individuals or teams.

By setting up Code Owners, our repository will be better equipped to handle external contributions and maintain a high standard for incoming code.

✅ Steps to Configure Code Owners

To achieve this, we'll need to follow these steps:

1. Create or Update the CODEOWNERS File

The CODEOWNERS file defines who is responsible for reviewing different parts of the codebase. It can be located in the following directories of master branch:

  • The root of the repository
  • The .github directory
  • The docs directory

But we'll go for creating file inside .github folder

To create the file, add the following line to your CODEOWNERS file:

* @Agoric/engprodexec

This will set the Agoric/engprodexec team as the default reviewer for all files in the repository.

Note: We can further add files/folders wise segregation as well.

More details here: GH Code-Owners

2. Update Branch Protection Rules

Once the CODEOWNERS file is set up, the next step is to ensure that code owner reviews are required for merging PRs. This can be done by enabling the appropriate branch protection rules.

To configure branch protection rules:

  • Navigate to Settings > Branches.
  • Select the branch (e.g., master in our case) and click Edit next to the branch protection rule.
  • Check the option for Require review from Code Owners.

We can directly visit the edit rules link for "master" branch (https://github.com/Agoric/agoric-sdk/settings/branch_protection_rules/17002382). Accessible to admin/owners of repo only.

This ensures that any PR touching the code owned by the specified team will require a review from them before it can be merged.

3. Provide Repo Write Access to the Team

For Code Owners to approve PRs, they need write access to our repository. To grant this:

Note: We don't need to perform above steps as engprodexec team has already the write access.

🔔 Review Assigned Notifications:

After getting done with code-owners configuration, we'll be having auto assignment of code-owners review on new opening PRs. This will create hassle and noise of "Review Requested" notifications to every team member. Is there any way to reduce that noise? Can we stop this notification while team-assignment? Let's get answer to these concerns in detail:

Does GH provide native support to disable these notifications?

Unfortunately, GH doesn't provide such native notification settings where we could disable team review assignment notifications while keeping individual assignment active. Either we disable review assignment notifications completely or keep both (individual and team).

References: https://github.com/orgs/community/discussions/15747 https://github.com/orgs/community/discussions/15747#discussioncomment-5583613

So what can we do? Is there any workaround or hack?

The answer to this is YES. Let's see how:

  1. Have a dummy account and add it in the GH team
  2. Go to Team settings page (ed: https://github.com/orgs/Agoric/teams/engprodexec/edit/review_assignment)
  3. Check "Enable Auto Assignment" and "Only notify requested team members"
  4. Select "1" under "How many team members should be assigned to review?" option.
  5. Check "Never assign certain team members" and select all team members while keeping the dummyUser un-selected.

FINAL PICTURE:

Screenshot 2024-09-16 at 6 45 53 PM

So what have we achieved from above steps?

The dummyUser here is taking one for the team. Assignment/notification will only be sent to that dummyUser and the remaining code-owners will still be able to approve/review having their review the same weightage.

External discussion on this hack: https://github.com/orgs/community/discussions/35673

🔍 Filtering Your Requested Reviews:

  1. You'll need to update the review filter to user-review-requested:@me to see the reviews where you are individually requested instead of team.
  2. Incase to see reviews not assigned to you BUT assigned to your team, -user-review-requested:@me team-review-requested:Agoric/engprodexec

🔔 Recommended Notification Settings for GH Slack App

If you're using GH slack app for notifications, you'll be having noise of "Team Review Assigned" alerts.

To avoid this noise, follow this recommended notification settings:

  1. Go to https://github.com/settings/reminders/Agoric
  2. Uncheck following options:
    • "Review requests assigned to your team".
    • "Your team is assigned a review"

Here's quick screenshot pointing out the relevant options 1000034160

Clone this wiki locally