Skip to content

Commit ab0da57

Browse files
Trotttargos
authored andcommitted
doc: make minor improvements to collab guide
PR-URL: #21862 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
1 parent 292aa42 commit ab0da57

File tree

1 file changed

+16
-17
lines changed

1 file changed

+16
-17
lines changed

COLLABORATOR_GUIDE.md

+16-17
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ For first-time contributors, check if the commit author is the same as the
6767
pull request author, and ask if they have configured their git
6868
username and email to their liking as per [this guide][git-username].
6969
This is to make sure they would be promoted to "contributor" once
70-
their pull request gets landed.
70+
their pull request lands.
7171

7272
### Closing Issues and Pull Requests
7373

@@ -82,32 +82,31 @@ necessary.
8282
### Author ready pull requests
8383

8484
A pull request that is still awaiting the minimum review time is considered
85-
`author-ready` as soon as the CI has been started, it has at least one approval,
85+
_author ready_ as soon as the CI has been started, it has at least one approval,
8686
and it has no outstanding review comments. Please always make sure to add the
87-
appropriate `author-ready` label to the PR in that case and remove it again as
88-
soon as that condition is not met anymore.
87+
`author ready` label to the PR in that case and remove it again as soon as that
88+
condition is not met anymore.
8989

9090
### Handling own pull requests
9191

92-
If you as a Collaborator open a pull request, it is recommended to start a CI
93-
right after (see [testing and CI](#testing-and-ci) for further information on
94-
how to do that) and to post the link to it as well. Starting a new CI after each
95-
update is also recommended (due to e.g., a change request in a review or due to
96-
rebasing).
92+
When you open a pull request, it is recommended to start a CI right away (see
93+
[testing and CI](#testing-and-ci) for instructions) and to post the link to it
94+
in a comment in the pull request. Starting a new CI after each update is also
95+
recommended (for example, after an additional code change or after rebasing).
9796

98-
As soon as the PR is ready to land, please go ahead and do so on your own.
99-
Landing your own pull requests distributes the work load for each Collaborator
100-
equally. If it is still awaiting the
101-
[minimum time to land](#waiting-for-approvals), please add the `author-ready`
102-
label to it so it is obvious that the PR can land as soon as the time ends.
97+
As soon as the PR is ready to land, please do so. Landing your own pull requests
98+
allows other Collaborators to focus on other pull requests. If your pull request
99+
is still awaiting the [minimum time to land](#waiting-for-approvals), add the
100+
`author ready` label so other Collaborators know it can land as soon as the time
101+
ends.
103102

104103
## Accepting Modifications
105104

106105
All modifications to the Node.js code and documentation should be performed via
107106
GitHub pull requests, including modifications by Collaborators and TSC members.
108107
A pull request must be reviewed, and must also be tested with CI, before being
109-
landed into the codebase. There may be exception to the latter (the changed code
110-
can not be tested with a CI or similar). If that is the case, please leave a
108+
landed into the codebase. There may be exceptions to the latter (the changed
109+
code cannot be tested with a CI or similar). If that is the case, please leave a
111110
comment that explains why the PR does not require a CI run.
112111

113112
### Code Reviews
@@ -140,7 +139,7 @@ the CI outcome.
140139
If there is no disagreement amongst Collaborators, a pull request should be
141140
landed given appropriate review, a green CI, and the minimum
142141
[waiting time](#waiting-for-approvals) for a PR. If it is still awaiting the
143-
[minimum time to land](#waiting-for-approvals), please add the `author-ready`
142+
[minimum time to land](#waiting-for-approvals), please add the `author ready`
144143
label to it so it is obvious that the PR can land as soon as the time ends.
145144

146145
Where there is discussion amongst Collaborators, consensus should be sought if

0 commit comments

Comments
 (0)