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 #747

Open
BenWibking opened this issue Sep 23, 2024 · 2 comments · May be fixed by #749
Open

add CODEOWNERS file #747

BenWibking opened this issue Sep 23, 2024 · 2 comments · May be fixed by #749
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@BenWibking
Copy link
Collaborator

BenWibking commented Sep 23, 2024

Describe the proposal
GitHub allows the use of a CODEOWNERS file that specifies whose approval is required for PRs that modify certain specified files. Those people will be automatically assigned as reviewers of PRs that modify those files, and their approval is required for that PR to be approved.

This is useful to ensure that PRs that modify certain parts of the code are reviewed by the appropriate people. Many parts of the code have esoteric details that are not well documented, and it could be dangerous to allow anyone to approve PRs for parts of the code they are not an expert in.

Describe alternatives you've considered
Keep the PR review process as-is.

Additional context
Athena++ CODEOWNERS file: https://github.com/PrincetonUniversity/athena/blob/master/.github/CODEOWNERS

@BenWibking BenWibking added the enhancement New feature or request label Sep 23, 2024
@dosubot dosubot bot added the documentation Improvements or additions to documentation label Sep 23, 2024
@BenWibking
Copy link
Collaborator Author

For instance, I think it would make sense for me to the be the "code owner" for everything in src/hydro/* and @chongchonghe to be the code owner for everything in src/radiation/*.

@BenWibking
Copy link
Collaborator Author

@psharda should be the code owner for everything in src/chemistry/*.

@BenWibking BenWibking linked a pull request Sep 24, 2024 that will close this issue
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant