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

Mention that adding codeowners will likely spam lots of users very quickly #34503

Closed
1 task done
jsoref opened this issue Sep 5, 2024 · 4 comments
Closed
1 task done
Labels
content This issue or pull request belongs to the Docs Content team repositories Content related to repositories waiting for review Issue/PR is waiting for a writer's review

Comments

@jsoref
Copy link
Contributor

jsoref commented Sep 5, 2024

Code of Conduct

What article on docs.github.com is affected?

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

What part(s) of the article would you like to see updated?

CODEOWNERS and branch protection or a section thereafter should be updated to say something like:

If you have many open PRs or will have many PRs that touch the files you're protecting with a group, then unless you have already made the group secret, you will probably be triggering a lot of email to the team when you add the group to CODEOWNERS. This will probably not be welcome. You should probably make the team secret before you apply these changes. See !AUTOTITLE

The relevant page:
https://docs.github.com/en/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team#configuring-team-notifications

Additional information

We just added CODEOWNERS to a repository that had a handful of open PRs with a rule to require any changes to be approved by a group that contains most of our staff. Upon merging the file and enabling the rule, we almost immediately got a number of emails for random changes to random PRs in the repository. This isn't technically wrong, but it was absolutely unwelcome and I was going to get yelled at very quickly for making the change I made. -- The documentation here was the right place to warn me to prevent the flack for such a change.

@jsoref jsoref added the content This issue or pull request belongs to the Docs Content team label Sep 5, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Sep 5, 2024
@nguyenalex836
Copy link
Contributor

@jsoref Thank you for opening an issue! I'll get this triaged for review ✨

@nguyenalex836 nguyenalex836 added waiting for review Issue/PR is waiting for a writer's review repositories Content related to repositories and removed triage Do not begin working on this issue until triaged by the team labels Sep 5, 2024
@Nopandi1101

This comment was marked as spam.

@VIVAGLEN

This comment was marked as spam.

@nguyenalex836
Copy link
Contributor

@jsoref 👋 Thank you for your patience while our team reviewed! After reviewing your issue, we've determined the best place to send your feedback regarding this feature is to https://github.com/orgs/community/discussions/categories/repositories

If there's anything else in the documents that you have suggestions for updating, please feel free to open an issue in this repo 💛

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team repositories Content related to repositories waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

No branches or pull requests

5 participants
@jsoref @Nopandi1101 @VIVAGLEN @nguyenalex836 and others