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

Add CODEOWNERS file #1768

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add CODEOWNERS file #1768

wants to merge 1 commit into from

Conversation

nirs
Copy link
Member

@nirs nirs commented Jan 26, 2025

The CODEOWNERS[1] file define individuals or teams that are responsible for code in a repository.

People with write permissions for the repository can create or edit the CODEOWNERS file and be listed as code owners. People with admin or owner permissions can require that pull requests have to be approved by code owners before they can be merged.

How this change the development flow?

  • When a pull request is created, owners of file touched by the pull request are added automatically as reviewers. This improves the experience for new contributors.

  • Using branch protection we can require that at least one of the owners will approve the pull request before it can be merged.

  • New contributors can learn who owns the code that want to change.

Issues:

  • Need a second owner for most rules, both for another review, and to avoid blocking merge if a single code owner is not available.

[1] https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

Fixes: #1766

CODEOWNERS Outdated Show resolved Hide resolved
@rakeshgm
Copy link
Member

the change looks good, i have given my approval anyway.

CODEOWNERS Outdated Show resolved Hide resolved
CODEOWNERS Outdated Show resolved Hide resolved
CODEOWNERS Outdated Show resolved Hide resolved
CODEOWNERS Outdated Show resolved Hide resolved
@nirs nirs force-pushed the codeowners branch 2 times, most recently from 8a54047 to 161fe6c Compare January 28, 2025 22:03
CODEOWNERS Outdated Show resolved Hide resolved
The CODEOWNERS[1] file define individuals or teams that are responsible
for code in a repository.

People with write permissions for the repository can create or edit the
CODEOWNERS file and be listed as code owners. People with admin or owner
permissions can require that pull requests have to be approved by code
owners before they can be merged.

How this change the development flow?

- When a pull request is created, owners of file touched by the pull
  request are added automatically as reviewers. This improves the
  experience for new contributors.

- Using branch protection we can require that at least one of the owners
  will approve the pull request before it can be merged.

- New contributors can learn who owns the code that want to change.

[1] https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

Fixes: RamenDR#1766
Signed-off-by: Nir Soffer <[email protected]>
@nirs nirs marked this pull request as ready for review February 5, 2025 19:21
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.

Add CODEOWNERS file
6 participants