Skip to content

Commit 8e3d173

Browse files
dgp1130vikerman
authored andcommitted
docs: add "PR action: merge" label (#16413)
This label should be placed by the author (or last reviewer if author is not a collaborator) when the PR is complete and ready to merged. This requires the author to explicitly acknolwedge that they are done with the PR and the caretaker is free to merge it. This label brings the CLI caretaking process into alignment with the frameworks and components repos.
1 parent 6d422b3 commit 8e3d173

File tree

3 files changed

+23
-9
lines changed

3 files changed

+23
-9
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,14 +110,21 @@ Before you submit your Pull Request (PR) consider the following guidelines:
110110
* If we suggest changes then:
111111
* Make the required updates.
112112
* Re-run the Angular DevKit test suites to ensure tests are still passing.
113-
* Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
113+
* Once your PR is approved and you are done with any follow up changes:
114+
* Rebase to the current master to pre-emptively address any merge conflicts.
114115

115116
```shell
116117
git rebase master -i
117118
git push -f
118119
```
120+
* Add the `PR action: merge` label and the correct
121+
[target label](https://github.com/angular/angular/blob/master/docs/TRIAGE_AND_LABELS.md#pr-target)
122+
(if PR author has the project collaborator status, or else the last reviewer
123+
should do this).
124+
* The current caretaker will merge the PR to the target branch(es) within 1-2
125+
business days.
119126

120-
That's it! Thank you for your contribution!
127+
That's it! 🎉 Thank you for your contribution!
121128
122129
#### After your pull request is merged
123130
@@ -301,12 +308,12 @@ yarn bazel run //etc/api:angular_devkit_core_api.accept
301308
**Note**: In some cases we use aliased symbols to create namespaces.
302309
303310
Example:
304-
```javascript
311+
```javascript
305312
import * as foo from './foo';
306313
307314
export { foo };
308315
```
309-
There are currently not supported by the API guardian.
316+
There are currently not supported by the API guardian.
310317
To overcome this limitation we created `_golden-api.ts` in certain packages.
311318
312319
When adding a new API, it might be the case that you need to add it to `_golden-api.ts`.

docs/process/release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ TBD
1818
## Merging PRs
1919

2020
The list of PRs which are currently ready to merge (approved with passing status checks) can
21-
be found with [this search](https://github.com/angular/angular-cli/pulls?q=is%3Apr+is%3Aopen+review%3Aapproved+status%3Asuccess).
21+
be found with [this search](https://github.com/angular/angular-cli/pulls?q=is%3Apr+is%3Aopen+label%3A%22PR+action%3A+merge%22).
2222
This list should be checked daily and any ready PRs should be merged. For each
2323
PR, check the `PR target` label to understand where it should be merged to. If
2424
`master` is targetted, then click "Rebase and Merge". If the PR also targets a

scripts/templates/contributing.ejs

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,14 +110,21 @@ Before you submit your Pull Request (PR) consider the following guidelines:
110110
* If we suggest changes then:
111111
* Make the required updates.
112112
* Re-run the Angular DevKit test suites to ensure tests are still passing.
113-
* Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
113+
* Once your PR is approved and you are done with any follow up changes:
114+
* Rebase to the current master to pre-emptively address any merge conflicts.
114115

115116
```shell
116117
git rebase master -i
117118
git push -f
118119
```
120+
* Add the `PR action: merge` label and the correct
121+
[target label](https://github.com/angular/angular/blob/master/docs/TRIAGE_AND_LABELS.md#pr-target)
122+
(if PR author has the project collaborator status, or else the last reviewer
123+
should do this).
124+
* The current caretaker will merge the PR to the target branch(es) within 1-2
125+
business days.
119126

120-
That's it! Thank you for your contribution!
127+
That's it! 🎉 Thank you for your contribution!
121128

122129
#### After your pull request is merged
123130

@@ -290,12 +297,12 @@ yarn bazel run //etc/api:angular_devkit_core_api.accept
290297
**Note**: In some cases we use aliased symbols to create namespaces.
291298

292299
Example:
293-
```javascript
300+
```javascript
294301
import * as foo from './foo';
295302

296303
export { foo };
297304
```
298-
There are currently not supported by the API guardian.
305+
There are currently not supported by the API guardian.
299306
To overcome this limitation we created `_golden-api.ts` in certain packages.
300307

301308
When adding a new API, it might be the case that you need to add it to `_golden-api.ts`.

0 commit comments

Comments
 (0)