Skip to content

Commit 73aacab

Browse files
committed
1 parent 1efa8fe commit 73aacab

File tree

6 files changed

+78
-68
lines changed

6 files changed

+78
-68
lines changed

BUILDING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ $ make test-only
305305

306306
At this point, you are ready to make code changes and re-run the tests.
307307

308-
If you are running tests before submitting a Pull Request, the recommended
308+
If you are running tests before submitting a pull request, the recommended
309309
command is:
310310

311311
```console

doc/guides/collaborator-guide.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -488,7 +488,7 @@ The TSC serves as the final arbiter where required.
488488
who wish to land their own pull requests will self-assign them. Sometimes, an
489489
author will delegate to someone else. If in doubt, ask the assignee whether
490490
it is okay to land.
491-
1. Never use GitHub's green ["Merge Pull Request"][] button. Reasons for not
491+
1. Never use GitHub's green ["Merge pull request"][] button. Reasons for not
492492
using the web interface button:
493493
* The "Create a merge commit" method will add an unnecessary merge commit.
494494
* The "Squash and merge" method will add metadata (the pull request #) to the
@@ -911,7 +911,7 @@ need to be attached anymore, as only important bugfixes will be included.
911911
* `arm`, `mips`, `s390`, `ppc`
912912
* No `x86{_64}` label because it is the implied default
913913

914-
["Merge Pull Request"]: https://help.github.com/articles/merging-a-pull-request/#merging-a-pull-request-on-github
914+
["Merge pull request"]: https://help.github.com/articles/merging-a-pull-request/#merging-a-pull-request-on-github
915915
[Deprecation]: https://en.wikipedia.org/wiki/Deprecation
916916
[SECURITY.md]: https://github.com/nodejs/node/blob/HEAD/SECURITY.md
917917
[Stability Index]: ../api/documentation.md#stability-index

doc/guides/commit-queue.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
> Stability: 1 - Experimental
44
5-
*tl;dr: You can land Pull Requests by adding the `commit-queue` label to it.*
5+
*tl;dr: You can land pull requests by adding the `commit-queue` label to it.*
66

77
Commit Queue is an experimental feature for the project which simplifies the
88
landing process by automating it via GitHub Actions. With it, collaborators can
9-
land Pull Requests by adding the `commit-queue` label to a PR. All
10-
checks will run via node-core-utils, and if the Pull Request is ready to land,
9+
land pull requests by adding the `commit-queue` label to a PR. All
10+
checks will run via node-core-utils, and if the pull request is ready to land,
1111
the Action will rebase it and push to master.
1212

1313
This document gives an overview of how the Commit Queue works, as well as
@@ -17,8 +17,8 @@ implementation details, reasoning for design choices, and current limitations.
1717

1818
From a high-level, the Commit Queue works as follow:
1919

20-
1. Collaborators will add `commit-queue` label to Pull Requests ready to land
21-
2. Every five minutes the queue will do the following for each Pull Request
20+
1. Collaborators will add `commit-queue` label to pull requests ready to land
21+
2. Every five minutes the queue will do the following for each pull request
2222
with the label:
2323
1. Check if the PR also has a `request-ci` label (if it has, skip this PR
2424
since it's pending a CI run)
@@ -40,10 +40,10 @@ From a high-level, the Commit Queue works as follow:
4040
## Current limitations
4141

4242
The Commit Queue feature is still in early stages, and as such it might not
43-
work for more complex Pull Requests. These are the currently known limitations
43+
work for more complex pull requests. These are the currently known limitations
4444
of the commit queue:
4545

46-
1. All commits in a Pull Request must either be following commit message
46+
1. All commits in a pull request must either be following commit message
4747
guidelines or be a valid [`fixup!`](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---fixupltcommitgt)
4848
commit that will be correctly handled by the [`--autosquash`](https://git-scm.com/docs/git-rebase#Documentation/git-rebase.txt---autosquash)
4949
option
@@ -73,7 +73,7 @@ reasons:
7373
`node-core-utils` is configured with a personal token and
7474
a Jenkins token from
7575
[@nodejs-github-bot](https://github.com/nodejs/github-bot).
76-
`octokit/graphql-action` is used to fetch all Pull Requests with the
76+
`octokit/graphql-action` is used to fetch all pull requests with the
7777
`commit-queue` label. The output is a JSON payload, so `jq` is used to turn
7878
that into a list of PR ids we can pass as arguments to
7979
[`commit-queue.sh`](../../tools/actions/commit-queue.sh).
@@ -87,8 +87,8 @@ that into a list of PR ids we can pass as arguments to
8787
1. The repository owner
8888
2. The repository name
8989
3. The Action GITHUB_TOKEN
90-
4. Every positional argument starting at this one will be a Pull Request ID of
91-
a Pull Request with commit-queue set.
90+
4. Every positional argument starting at this one will be a pull request ID of
91+
a pull request with commit-queue set.
9292

9393
The script will iterate over the pull requests. `ncu-ci` is used to check if
9494
the last CI is still pending, and calls to the GitHub API are used to check if

0 commit comments

Comments
 (0)