The pull request reviewing process and labeling strategy is described as
part of a dedicated file in `project/REVIEWING.md`: remove the existing
description from the `MAINTAINERS` file.
Signed-off-by: Arnaud Porterie <arnaud.porterie@docker.com>
| ... | ... |
@@ -124,98 +124,8 @@ the relevant operators. |
| 124 | 124 |
|
| 125 | 125 |
* If the change affects the governance, philosophy, goals or principles of the project, |
| 126 | 126 |
it must be approved by BDFL. |
| 127 |
- |
|
| 128 |
-* A pull request can be in 1 of 5 distinct states, for each of which there is a corresponding label |
|
| 129 |
-that needs to be applied. `Rules.review.states` contains the list of states with possible targets |
|
| 130 |
-for each. |
|
| 131 | 127 |
""" |
| 132 | 128 |
|
| 133 |
- # Triage |
|
| 134 |
- [Rules.review.states.0-needs-triage] |
|
| 135 |
- |
|
| 136 |
- # Maintainers are expected to triage new incoming pull requests by removing |
|
| 137 |
- # the `0-triage` label and adding the correct labels (e.g. `1-design-review`) |
|
| 138 |
- # potentially skipping some steps depending on the kind of pull request. |
|
| 139 |
- # Use common sense for judging. |
|
| 140 |
- # |
|
| 141 |
- # Checking for DCO should be done at this stage. |
|
| 142 |
- # |
|
| 143 |
- # If an owner, responsible for closing or merging, can be assigned to the PR, |
|
| 144 |
- # the better. |
|
| 145 |
- |
|
| 146 |
- close = "e.g. unresponsive contributor without DCO" |
|
| 147 |
- 3-docs-review = "non-proposal documentation-only change" |
|
| 148 |
- 2-code-review = "e.g. trivial bugfix" |
|
| 149 |
- 1-design-review = "general case" |
|
| 150 |
- |
|
| 151 |
- # Design review |
|
| 152 |
- [Rules.review.states.1-needs-design-review] |
|
| 153 |
- |
|
| 154 |
- # Maintainers are expected to comment on the design of the pull request. |
|
| 155 |
- # Review of documentation is expected only in the context of design validation, |
|
| 156 |
- # not for stylistic changes. |
|
| 157 |
- # |
|
| 158 |
- # Ideally, documentation should reflect the expected behavior of the code. |
|
| 159 |
- # No code review should take place in this step. |
|
| 160 |
- # |
|
| 161 |
- # Once design is approved, a maintainer should make sure to remove this label |
|
| 162 |
- # and add the next one. |
|
| 163 |
- |
|
| 164 |
- close = "design rejected" |
|
| 165 |
- 3-docs-review = "proposals with only documentation changes" |
|
| 166 |
- 2-code-review = "general case" |
|
| 167 |
- |
|
| 168 |
- # Code review |
|
| 169 |
- [Rules.review.states.2-needs-code-review] |
|
| 170 |
- |
|
| 171 |
- # Maintainers are expected to review the code and ensure that it is good |
|
| 172 |
- # quality and in accordance with the documentation in the PR. |
|
| 173 |
- # |
|
| 174 |
- # If documentation is absent but expected, maintainers should ask for documentation. |
|
| 175 |
- # |
|
| 176 |
- # All tests should pass. |
|
| 177 |
- # |
|
| 178 |
- # Once code is approved according to the rules of the subsystem, a maintainer |
|
| 179 |
- # should make sure to remove this label and add the next one. |
|
| 180 |
- |
|
| 181 |
- close = "" |
|
| 182 |
- 1-design-review = "raises design concerns" |
|
| 183 |
- 4-merge = "trivial change not impacting documentation" |
|
| 184 |
- 3-docs-review = "general case" |
|
| 185 |
- |
|
| 186 |
- # Docs review |
|
| 187 |
- [Rules.review.states.3-needs-docs-review] |
|
| 188 |
- |
|
| 189 |
- # Maintainers are expected to review the documentation in its bigger context, |
|
| 190 |
- # ensuring consistency, completeness, validity, and breadth of coverage across |
|
| 191 |
- # all extent and new documentation. |
|
| 192 |
- # |
|
| 193 |
- # They should ask for any editorial change that makes the documentation more |
|
| 194 |
- # consistent and easier to understand. |
|
| 195 |
- # |
|
| 196 |
- # Changes and additions to docs must be reviewed and approved (LGTM'd) by a minimum of |
|
| 197 |
- # two docs sub-project maintainers. If the docs change originates with a docs |
|
| 198 |
- # maintainer, only one additional LGTM is required (since we assume a docs maintainer |
|
| 199 |
- # approves of their own PR). |
|
| 200 |
- # |
|
| 201 |
- # Once documentation is approved (see below), a maintainer should make sure to remove this |
|
| 202 |
- # label and add the next one. |
|
| 203 |
- |
|
| 204 |
- close = "" |
|
| 205 |
- 2-code-review = "requires more code changes" |
|
| 206 |
- 1-design-review = "raises design concerns" |
|
| 207 |
- 4-merge = "general case" |
|
| 208 |
- |
|
| 209 |
- # Merge |
|
| 210 |
- [Rules.review.states.4-needs-merge] |
|
| 211 |
- |
|
| 212 |
- # Maintainers are expected to merge this pull request as soon as possible. |
|
| 213 |
- # They can ask for a rebase, or carry the pull request themselves. |
|
| 214 |
- # These should be the easy PRs to merge. |
|
| 215 |
- |
|
| 216 |
- close = "carry PR" |
|
| 217 |
- merge = "" |
|
| 218 |
- |
|
| 219 | 129 |
[Rules.DCO] |
| 220 | 130 |
|
| 221 | 131 |
title = "Helping contributors with the DCO" |