Skip to content

Commit bef8231

Browse files
DarylCantrellpatrick-knightmchammer01
authored
Expanded required reviewers section in rulesets documentation (#59406)
Co-authored-by: Patrick Knight <patrick-knight@github.com> Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
1 parent 63c3584 commit bef8231

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,25 @@ Optionally, you can require a merge type of merge, squash, or rebase. This means
135135
{% endif %}
136136

137137
{% ifversion repo-rules-required-reviewer %}
138-
Optionally, you can require review from specific teams. This means you can add a select number of reviewers who must submit a specific number of reviews for specific files and folders.
138+
139+
#### Required reviewers
140+
141+
Optionally, you can require review or approval from specific teams when a pull request changes certain files or directories. You can specify up to 15 different teams, and for each team you can require a certain number of approvals from team members.
142+
143+
The **Reviewer** dropdown allows you to select any team which is in scope where the rule is being defined.
144+
145+
* **Organization-wide rules**: The team must belong to the organization.
146+
* **Repository-level rules**: The team must belong to the organization that owns the repository.
147+
148+
This rule is not available on user-owned repositories as they do not contain teams.
149+
150+
Required approvals can be set from 0 (zero) to 10. Requiring zero approvals means that the team will be added for visibility, but the team does not need to approve the request.
151+
152+
For each team, you can specify a list of file patterns which determines what files the setting applies to. The format of this file list is the same as a standard [`.gitignore`](/get-started/git-basics/ignoring-files) file:
153+
154+
* A pattern starting with an exclamation mark (`!`) is a negation. This will cause paths matching earlier patterns to *not* require approvals.
155+
* Patterns are matched in order, so negated patterns can "unmatch" files which matched previous rules.
156+
139157
{% endif %}
140158

141159
## Require status checks to pass before merging

0 commit comments

Comments
 (0)