Add CODEOWNERS file #1766
Assignees
Labels
project
Related to operational management of the project
Comments
nirs
added a commit
to nirs/ramen
that referenced
this issue
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: RamenDR#1766 Signed-off-by: Nir Soffer <[email protected]>
nirs
added a commit
to nirs/ramen
that referenced
this issue
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: RamenDR#1766 Signed-off-by: Nir Soffer <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
When pull request is created, we want the owners of the relevant code to be added as reviewers. This improve the contributor experience by getting immediate feedback for the pull request.
When merging, we want branch protection rules to ensure that owners of particular area of files approve the change. To make sure this does not block merging, we need at least 2 owners for every file.
Main owners by topic:
Issues:
Reference for github CODEOWNERS file:
https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
The text was updated successfully, but these errors were encountered: