-
Notifications
You must be signed in to change notification settings - Fork 0
/
CODEOWNERS
Validating CODEOWNERS rules...
38 lines (29 loc) · 3 KB
/
CODEOWNERS
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# Overview
# The CODEOWNERS file is a GitHub's feature which allows you to create an overview of the code ownership structure in your repository.
# Specify the default owners of your repository and code owners of particular repository parts to define who is automatically requested for a review each time a contributor creates a pull request to the main branch.
# Modify the default settings of the repository and select the "Require review from Code Owners" option on the protected main branch to require one approval from the owners of every part of the repository included in the pull request. For more details, read the following article on GitHub: https://help.github.com/articles/enabling-required-reviews-for-pull-requests/.
# Details
# The CODEOWNERS file is located at the root of your repository and includes a specification of the code ownership structure of the repository.
# It is up to you to decide who is responsible for the review of particular parts and types of files in your repository.
# When defining the file, keep in mind the following rules:
# Lines starting with a hash (#) are comments.
# Each line of the file is a file pattern followed by one or more owners.
# You can use individual GitHub usernames, e-mail addresses, or team names to define owners. To define the owners with a team name, first add the team to your repository as collaborators with write access permissions. For more details, read the following article on GitHub: https://help.github.com/articles/adding-outside-collaborators-to-repositories-in-your-organization/.
# Define the default owners of the repository. They are automatically requested for a review of any content at the root of the repository and any content for which no owners are specified in this file.
# Provide granular ownership specification for folders and subfolders. You can also define the owners of specific file types in your repository.
# The order is important. The last matching pattern in the file has the most precedence.
# Examples
# These are the default owners for the whole content of the repository, including the content for which no owners are specified in the file.
# * @global-owner1 globalowner@example.com @org/team-name
# The following rule indicates that if a pull request affects folder1 at the root of the repository and any content in that folder, only this owner is requested for a review.
# /folder1/ @testuser1
# When you use the following pattern, you specify that @testuser2 is responsible for the review of any file in folder2, excluding subfolders located therein.
# /folder2/* @testuser2
# In this example, you define @testuser3 as the owner of any content in every "docs" folder in the repository.
# docs/ @testuser3
# When you open a pull request that modifies the "yaml" files, only @testuser4 is requested for a review, and the global owner(s) are not.
# *.yaml @testuser4
# Reference
# For more details, read the following articles on GitHub:
# https://help.github.com/articles/about-codeowners/
# https://github.com/blog/2392-introducing-code-owners/