docs icon indicating copy to clipboard operation
docs copied to clipboard

Team names required syntax when used for CODEOWNERS file

Open OsirisTerje opened this issue 1 year ago • 2 comments
trafficstars

Code of Conduct

What article on docs.github.com is affected?

This one about creating a team doesn't state the allowed syntax for a team name: https://docs.github.com/en/organizations/organizing-members-into-teams/creating-a-team And this page on CODEOWNERS, https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners#codeowners-syntax, doesn't mention it either.

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

A section on syntax for team names should be added.

A team name with '.' included is not allowed in a CODEOWNERS file, resulting in the following error: image

and the error description points to the characters from the dot to the end.

I would assume that casing of the team name is also critical. There might also be other non-allowed characters besides those mentioned on the CODEOWNERs page.

Additional information

This would affect all organizations that are using team names with dots.

This syntax is correct: image

OsirisTerje avatar May 06 '24 15:05 OsirisTerje

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar May 06 '24 15:05 welcome[bot]

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

nguyenalex836 avatar May 06 '24 18:05 nguyenalex836