You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md
+6-15Lines changed: 6 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,6 +50,8 @@ To reduce the size of your CODEOWNERS file, consider using wildcard patterns to
50
50
A CODEOWNERS file uses a pattern that follows most of the same rules used in [gitignore](https://git-scm.com/docs/gitignore#_pattern_format) files, with [some exceptions](#syntax-exceptions). The pattern is followed by one or more {% data variables.product.prodname_dotcom %} usernames or team names using the standard `@username` or `@org/team-name` format. Users must have `read` access to the repository and teams must have explicit `write` access, even if the team's members already have access. You can also refer to a user by an email address that has been added to their account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, for example `[email protected]`.
51
51
52
52
If any line in your CODEOWNERS file contains invalid syntax, the file will not be detected and will not be used to request reviews.
53
+
54
+
CODEOWNERS paths are case sensitive, because {% data variables.product.prodname_dotcom %} uses a case sensitive file system. Since CODEOWNERS are evaluated by {% data variables.product.prodname_dotcom %}, even systems that are case insensitive (for example, macOS) must use paths and files that are cased correctly in the CODEOWNERS file.
53
55
### Example of a CODEOWNERS file
54
56
```
55
57
# This is a comment.
@@ -97,6 +99,10 @@ apps/ @octocat
97
99
# subdirectories.
98
100
/docs/ @doctocat
99
101
102
+
# In this example, any change inside the `/scripts` directory
103
+
# will require approval from @doctocat or @octocat.
104
+
/scripts/ @doctocat @octocat
105
+
100
106
# In this example, @octocat owns any file in the `/apps`
101
107
# directory in the root of your repository except for the `/apps/github`
102
108
# subdirectory, as its owners are left empty.
@@ -112,21 +118,6 @@ There are some syntax rules for gitignore files that do not work in CODEOWNERS f
112
118
## CODEOWNERS and branch protection
113
119
Repository owners can add branch protection rules to ensure that changed code is reviewed by the owners of the changed files. For more information, see "[About protected branches](/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)."
114
120
115
-
### Example of a CODEOWNERS file
116
-
```
117
-
# In this example, any change inside the `/apps` directory
118
-
# will require approval from @doctocat.
119
-
/apps/ @doctocat
120
-
121
-
# In this example, any change inside the `/apps` directory
122
-
# will require approval from @doctocat or @octocat.
123
-
/apps/ @doctocat @octocat
124
-
125
-
# In this example, any change inside the `/apps` directory
126
-
# will require approval from a member of the @example-org/content team.
0 commit comments