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

[FEATURE] Split CODEOWNERS to better identify actual code owners #1252

Closed
Swiddis opened this issue Nov 15, 2023 · 1 comment
Closed

[FEATURE] Split CODEOWNERS to better identify actual code owners #1252

Swiddis opened this issue Nov 15, 2023 · 1 comment
Assignees
Labels
enhancement New feature or request maintenance

Comments

@Swiddis
Copy link
Collaborator

Swiddis commented Nov 15, 2023

Is your feature request related to a problem?
Our current CODEOWNERS file currently marks every maintainer as an owner of the entire codebase. The issue is that code owners are automatically added as reviewers to PRs that touch owned code, which in practice means that every maintainer is assigned as a reviewer on every PR. This makes the review notifications very noisy and makes it harder to identify PRs where a maintainer is actually needed.

What solution would you like?
CODEOWNERS turns out to be capable of much more than a global mask, though. It supports gitignore-like syntax to assign owners to individual files. By making better use of this file, we can get PRs to the people that need to see them, faster. For example, for adding the integrations project's main developers, we could consider adding the line:

**/integrations   @Swiddis @YANG-DB 

Which would add only the two mentioned devs as a reviewer, since CODEOWNERS only applies the last matching line in a file.

It also can just reference the opensearch-project/observability team directly instead of listing every dev, which has the benefit of better dynamic management and also would help make the review process less noisy.

*   @opensearch-project/observability 

What alternatives have you considered?
There are a few other approaches to the issue.

  • We could just disable automatically adding code owners in the repository review settings, making the process manual. I think this would still be better than adding everyone.
  • We could use a more elaborate system like assign-reviewer-by-label to implement this functionality through PR labels instead of CODEOWNERS.

Do you have any additional context?
This type of strategy is put to good use in some large projects like CPython and Node.js

@peternied
Copy link
Member

peternied commented Nov 16, 2023

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request maintenance
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants