Skip to content

Commit 09687b8

Browse files
Trottaddaleax
authored andcommitted
doc: avoid _may_ in collaborator guide
Many style guides (including Microsoft's) suggest avoiding _may_ because it can be unclear. Using _can_ or _might_ tends to increase clarity. An example in this change: > They may not change to a Runtime Deprecation until the next major > release. It's not clear if that means "They can not change until the next major release" or "They might not change until the next major release but also might change before then". Using _can_ or _might_ instead of _may_ clears up the ambiguity. Refs: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/can-may PR-URL: #34749 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Shingo Inoue <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Anto Aravinth <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent 39dc408 commit 09687b8

File tree

1 file changed

+32
-32
lines changed

1 file changed

+32
-32
lines changed

doc/guides/collaborator-guide.md

+32-32
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ as a _Contributor_. Ask if they have configured their git
5959

6060
### Closing issues and pull requests
6161

62-
Collaborators may close any issue or pull request that is not relevant to the
62+
Collaborators can close any issue or pull request that is not relevant to the
6363
future of the Node.js project. Where this is unclear, leave the issue or pull
6464
request open for several days to allow for discussion. Where this does not yield
6565
evidence that the issue or pull request has relevance, close it. Remember that
@@ -104,8 +104,8 @@ for the change.
104104

105105
Approval must be from Collaborators who are not authors of the change.
106106

107-
In some cases, it may be necessary to summon a GitHub team to a pull request for
108-
review by @-mention.
107+
In some cases, it might be necessary to summon a GitHub team to a pull request
108+
for review by @-mention.
109109
See [Who to CC in the issue tracker](#who-to-cc-in-the-issue-tracker).
110110

111111
If you are the first Collaborator to approve a pull request that has no CI yet,
@@ -114,7 +114,7 @@ pull request creator pushed new code since the last CI run.
114114

115115
### Consensus seeking
116116

117-
A pull request may land if it has the needed [approvals](#code-reviews),
117+
A pull request can land if it has the needed [approvals](#code-reviews),
118118
[CI](#testing-and-ci), [wait time](#waiting-for-approvals) and no
119119
[outstanding objections](#objections). [Breaking changes](#breaking-changes)
120120
must receive [TSC review](#involving-the-tsc) in addition to other
@@ -124,22 +124,22 @@ requirements. If a pull request meets all requirements except the
124124

125125
#### Objections
126126

127-
**Collaborators may object to a pull request by using the "Request
127+
**Collaborators can object to a pull request by using the "Request
128128
Changes" GitHub feature**. Dissent comments alone don't constitute an
129129
objection. **Any PR objection must include a clear reason for that objection,
130130
and the objector must remain responsive for further discussion towards
131131
consensus about the direction of the pull request**. Providing a set of
132132
actionable steps alongside the objection is recommended.
133133

134-
If the objection is not clear to others, another collaborator may ask an
134+
If the objection is not clear to others, another collaborator can ask an
135135
objecting collaborator to explain their objection or to provide actionable
136136
steps to resolve the objection. **If the objector is unresponsive for seven
137-
days after a collaborator asks for clarification, another collaborator may
137+
days after a collaborator asks for clarification, another collaborator can
138138
dismiss the objection**.
139139

140140
**Pull requests with outstanding objections must remain open until all
141141
objections are satisfied**. If reaching consensus is not possible, a
142-
collaborator may escalate the issue to the TSC by pinging `@nodejs/tsc` and
142+
collaborator can escalate the issue to the TSC by pinging `@nodejs/tsc` and
143143
adding the `tsc-agenda` label to the issue.
144144

145145
#### Helpful resources
@@ -151,27 +151,27 @@ adding the `tsc-agenda` label to the issue.
151151
### Waiting for approvals
152152

153153
Before landing pull requests, allow 48 hours for input from other Collaborators.
154-
Certain types of pull requests can be fast-tracked and may land after a shorter
154+
Certain types of pull requests can be fast-tracked and can land after a shorter
155155
delay. For example:
156156

157157
* Focused changes that affect only documentation and/or the test suite:
158158
* `code-and-learn` tasks often fall into this category.
159-
* `good-first-issue` pull requests may also be suitable.
159+
* `good-first-issue` pull requests might also be suitable.
160160
* Changes that fix regressions:
161161
* Regressions that break the workflow (red CI or broken compilation).
162162
* Regressions that happen right before a release, or reported soon after.
163163

164164
To propose fast-tracking a pull request, apply the `fast-track` label. Then add
165-
a comment that Collaborators may upvote.
165+
a comment that Collaborators can upvote.
166166

167167
If someone disagrees with the fast-tracking request, remove the label. Do not
168168
fast-track the pull request in that case.
169169

170-
The pull request may be fast-tracked if two Collaborators approve the
170+
The pull request can be fast-tracked if two Collaborators approve the
171171
fast-tracking request. To land, the pull request itself still needs two
172172
Collaborator approvals and a passing CI.
173173

174-
Collaborators may request fast-tracking of pull requests they did not author.
174+
Collaborators can request fast-tracking of pull requests they did not author.
175175
In that case only, the request itself is also one fast-track approval. Upvote
176176
the comment anyway to avoid any doubt.
177177

@@ -298,7 +298,7 @@ For more information, see [Deprecations](#deprecations).
298298

299299
#### Breaking changes to internal elements
300300

301-
Breaking changes to internal elements may occur in semver-patch or semver-minor
301+
Breaking changes to internal elements can occur in semver-patch or semver-minor
302302
commits. Take significant care when making and reviewing such changes. Make
303303
an effort to determine the potential impact of the change in the ecosystem. Use
304304
[Canary in the Goldmine](https://github.com/nodejs/citgm) to test such changes.
@@ -308,14 +308,14 @@ providing a Public API in such cases.
308308
#### Unintended breaking changes
309309

310310
Sometimes, a change intended to be non-breaking turns out to be a breaking
311-
change. If such a change lands on the master branch, a Collaborator may revert
312-
it. As an alternative to reverting, the TSC may apply the semver-major label
311+
change. If such a change lands on the master branch, a Collaborator can revert
312+
it. As an alternative to reverting, the TSC can apply the semver-major label
313313
after-the-fact.
314314

315315
##### Reverting commits
316316

317317
Revert commits with `git revert <HASH>` or `git revert <FROM>..<TO>`. The
318-
generated commit message will not have a subsystem and may violate line length
318+
generated commit message will not have a subsystem and might violate line length
319319
rules. That is OK. Append the reason for the revert and any `Refs` or `Fixes`
320320
metadata. Raise a pull request like any other change.
321321

@@ -355,7 +355,7 @@ documentation must state the deprecation status.
355355
* There are no functional changes.
356356
* By default, there will be no warnings emitted for such deprecations at
357357
runtime.
358-
* May cause a runtime warning with the [`--pending-deprecation`][] flag or
358+
* Might cause a runtime warning with the [`--pending-deprecation`][] flag or
359359
`NODE_PENDING_DEPRECATION` environment variable.
360360

361361
* Runtime Deprecation
@@ -364,15 +364,15 @@ documentation must state the deprecation status.
364364

365365
* End-of-Life
366366
* The API is no longer subject to the semantic versioning rules.
367-
* Backward-incompatible changes including complete removal of such APIs may
367+
* Backward-incompatible changes including complete removal of such APIs can
368368
occur at any time.
369369

370370
Apply the `notable change` label to all pull requests that introduce
371371
Documentation-Only Deprecations. Such deprecations have no impact on code
372372
execution. Thus, they are not breaking changes (`semver-major`).
373373

374374
Runtime Deprecations and End-of-Life APIs (internal or public) are breaking
375-
changes (`semver-major`). The TSC may make exceptions, deciding that one of
375+
changes (`semver-major`). The TSC can make exceptions, deciding that one of
376376
these deprecations is not a breaking change.
377377

378378
Avoid Runtime Deprecations when an alias or a stub/no-op will suffice. An alias
@@ -386,13 +386,13 @@ example, due to removal of an End-of-Life deprecated API).
386386

387387
<a id="deprecation-cycle"></a>
388388
A _deprecation cycle_ is a major release during which an API has been in one of
389-
the three Deprecation levels. Documentation-Only Deprecations may land in a
390-
minor release. They may not change to a Runtime Deprecation until the next major
389+
the three Deprecation levels. Documentation-Only Deprecations can land in a
390+
minor release. They can not change to a Runtime Deprecation until the next major
391391
release.
392392

393393
No API can change to End-of-Life without going through a Runtime Deprecation
394394
cycle. There is no rule that deprecated code must progress to End-of-Life.
395-
Documentation-Only and Runtime Deprecations may remain in place for an unlimited
395+
Documentation-Only and Runtime Deprecations can remain in place for an unlimited
396396
duration.
397397

398398
Communicate pending deprecations and associated mitigations with the ecosystem
@@ -404,7 +404,7 @@ deprecation level of an API.
404404

405405
### Involving the TSC
406406

407-
Collaborators may opt to elevate pull requests or issues to the [TSC][].
407+
Collaborators can opt to elevate pull requests or issues to the [TSC][].
408408
Do this if a pull request or issue:
409409

410410
* Is labeled `semver-major`, or
@@ -469,7 +469,7 @@ code. If you wish to create the token yourself in advance, see
469469

470470
### Technical HOWTO
471471

472-
Clear any `am`/`rebase` that may already be underway:
472+
Clear any `am`/`rebase` that might already be underway:
473473

474474
```text
475475
$ git am --abort
@@ -586,7 +586,7 @@ for that commit. This is an opportunity to fix commit messages.
586586
request. This makes it easy to trace a commit back to the conversation that
587587
led up to that change.
588588
* Optional: A `Fixes: X` line, where _X_ is the full GitHub URL for an
589-
issue. A commit message may include more than one `Fixes:` lines.
589+
issue. A commit message can include more than one `Fixes:` lines.
590590
* Optional: One or more `Refs:` lines referencing a URL for any relevant
591591
background.
592592
* Required: A `Reviewed-By: Name <email>` line for each Collaborator who
@@ -595,7 +595,7 @@ for that commit. This is an opportunity to fix commit messages.
595595
pull request.
596596
* Protects against the assumption that GitHub will be around forever.
597597

598-
Other changes may have landed on master since the successful CI run. As a
598+
Other changes might have landed on master since the successful CI run. As a
599599
precaution, run tests (`make -j4 test` or `vcbuild test`).
600600

601601
Confirm that the commit message format is correct using
@@ -628,8 +628,8 @@ more than one commit.
628628

629629
### Troubleshooting
630630

631-
Sometimes, when running `git push upstream master`, you may get an error message
632-
like this:
631+
Sometimes, when running `git push upstream master`, you might get an error
632+
message like this:
633633

634634
```console
635635
To https://github.com/nodejs/node
@@ -683,7 +683,7 @@ corresponding staging branch (v10.x-staging, v8.x-staging, etc.).
683683
Commits that land on master are cherry-picked to each staging branch as
684684
appropriate. If a change applies only to the LTS branch, open the PR against the
685685
*staging* branch. Commits from the staging branch land on the LTS branch only
686-
when a release is being prepared. They may land on the LTS branch in a different
686+
when a release is being prepared. They can land on the LTS branch in a different
687687
order than they were in staging.
688688

689689
Only members of @nodejs/backporters should land commits onto LTS staging
@@ -711,7 +711,7 @@ Likewise, as commits land in an LTS release, the releaser removes the `land-on-`
711711
label.
712712

713713
Attach the appropriate `lts-watch-` label to any pull request that
714-
may impact an LTS release.
714+
might impact an LTS release.
715715

716716
## Who to CC in the issue tracker
717717

@@ -759,7 +759,7 @@ may impact an LTS release.
759759
When things need extra attention, are controversial, or `semver-major`:
760760
@nodejs/tsc
761761

762-
If you cannot find who to cc for a file, `git shortlog -n -s <file>` may help.
762+
If you cannot find who to cc for a file, `git shortlog -n -s <file>` can help.
763763

764764
["Merge Pull Request"]: https://help.github.com/articles/merging-a-pull-request/#merging-a-pull-request-on-github
765765
[Deprecation]: https://en.wikipedia.org/wiki/Deprecation

0 commit comments

Comments
 (0)