Skip to content

Commit 5a9196e

Browse files
marsonyadanielleadams
authored andcommitted
doc: apply sentence case to headers in pull-requests.md
PR-URL: #37602 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 7422453 commit 5a9196e

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

doc/guides/contributing/pull-requests.md

+25-25
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,33 @@
44
* [Setting up your local environment](#setting-up-your-local-environment)
55
* [Step 1: Fork](#step-1-fork)
66
* [Step 2: Branch](#step-2-branch)
7-
* [The Process of Making Changes](#the-process-of-making-changes)
7+
* [The process of making changes](#the-process-of-making-changes)
88
* [Step 3: Code](#step-3-code)
99
* [Step 4: Commit](#step-4-commit)
1010
* [Commit message guidelines](#commit-message-guidelines)
1111
* [Step 5: Rebase](#step-5-rebase)
1212
* [Step 6: Test](#step-6-test)
1313
* [Step 7: Push](#step-7-push)
14-
* [Step 8: Opening the Pull Request](#step-8-opening-the-pull-request)
15-
* [Step 9: Discuss and Update](#step-9-discuss-and-update)
16-
* [Approval and Request Changes Workflow](#approval-and-request-changes-workflow)
14+
* [Step 8: Opening the pull request](#step-8-opening-the-pull-request)
15+
* [Step 9: Discuss and update](#step-9-discuss-and-update)
16+
* [Approval and request changes workflow](#approval-and-request-changes-workflow)
1717
* [Step 10: Landing](#step-10-landing)
18-
* [Reviewing Pull Requests](#reviewing-pull-requests)
18+
* [Reviewing pull requests](#reviewing-pull-requests)
1919
* [Review a bit at a time](#review-a-bit-at-a-time)
2020
* [Be aware of the person behind the code](#be-aware-of-the-person-behind-the-code)
2121
* [Respect the minimum wait time for comments](#respect-the-minimum-wait-time-for-comments)
22-
* [Abandoned or Stalled Pull Requests](#abandoned-or-stalled-pull-requests)
22+
* [Abandoned or stalled pull requests](#abandoned-or-stalled-pull-requests)
2323
* [Approving a change](#approving-a-change)
2424
* [Accept that there are different opinions about what belongs in Node.js](#accept-that-there-are-different-opinions-about-what-belongs-in-nodejs)
2525
* [Performance is not everything](#performance-is-not-everything)
26-
* [Continuous Integration Testing](#continuous-integration-testing)
26+
* [Continuous integration testing](#continuous-integration-testing)
2727
* [Notes](#notes)
28-
* [Commit Squashing](#commit-squashing)
29-
* [Getting Approvals for your Pull Request](#getting-approvals-for-your-pull-request)
30-
* [CI Testing](#ci-testing)
31-
* [Waiting Until the Pull Request Gets Landed](#waiting-until-the-pull-request-gets-landed)
32-
* [Check Out the Collaborator Guide](#check-out-the-collaborator-guide)
33-
* [Appendix: Subsystems](#appendix-subsystems)
28+
* [Commit squashing](#commit-squashing)
29+
* [Getting approvals for your pull request](#getting-approvals-for-your-pull-request)
30+
* [CI testing](#ci-testing)
31+
* [Waiting until the pull request gets landed](#waiting-until-the-pull-request-gets-landed)
32+
* [Check out the collaborator guide](#check-out-the-collaborator-guide)
33+
* [Appendix: subsystems](#appendix-subsystems)
3434

3535
## Dependencies
3636

@@ -107,7 +107,7 @@ directly off of the `master` branch.
107107
$ git checkout -b my-branch -t upstream/master
108108
```
109109

110-
## The Process of Making Changes
110+
## The process of making changes
111111

112112
### Step 3: Code
113113

@@ -261,7 +261,7 @@ your fork on GitHub.
261261
$ git push origin my-branch
262262
```
263263

264-
### Step 8: Opening the Pull Request
264+
### Step 8: Opening the pull request
265265

266266
From within GitHub, opening a new Pull Request will present you with a
267267
[pull request template][]. Please try to do your best at filling out the
@@ -318,7 +318,7 @@ awaiting an answer on something. If you encounter words or acronyms that
318318
seem unfamiliar, refer to this
319319
[glossary](https://sites.google.com/a/chromium.org/dev/glossary).
320320

321-
#### Approval and Request Changes Workflow
321+
#### Approval and request changes workflow
322322

323323
All Pull Requests require "sign off" in order to land. Whenever a contributor
324324
reviews a Pull Request they may find specific details that they would like to
@@ -353,7 +353,7 @@ point, but don't worry. If you look at the branch you raised your
353353
Pull Request against (probably `master`), you should see a commit with
354354
your name on it. Congratulations and thanks for your contribution!
355355

356-
## Reviewing Pull Requests
356+
## Reviewing pull requests
357357

358358
All Node.js contributors who choose to review and provide feedback on Pull
359359
Requests have a responsibility to both the project and the individual making the
@@ -429,7 +429,7 @@ matter experts. When in doubt, do not rush.
429429
Trivial changes, typically limited to small formatting changes or fixes to
430430
documentation, may be landed within the minimum 48 hour window.
431431

432-
### Abandoned or Stalled Pull Requests
432+
### Abandoned or stalled pull requests
433433

434434
If a Pull Request appears to be abandoned or stalled, it is polite to first
435435
check with the contributor to see if they intend to continue the work before
@@ -507,7 +507,7 @@ advice on what would make the Pull Request acceptable, and do not assume that
507507
the contributor should already know how to do that. Be explicit in your
508508
feedback.
509509

510-
### Continuous Integration Testing
510+
### Continuous integration testing
511511

512512
All Pull Requests that contain changes to code must be run through
513513
continuous integration (CI) testing at [https://ci.nodejs.org/][].
@@ -526,7 +526,7 @@ whether the failure was caused by the changes in the Pull Request.
526526

527527
## Notes
528528

529-
### Commit Squashing
529+
### Commit squashing
530530

531531
In most cases, do not squash commits that you add to your Pull Request during
532532
the review process. When the commits in your Pull Request land, they may be
@@ -541,7 +541,7 @@ can be a good example. It touches the implementation, the documentation,
541541
and the tests, but is still one logical change. All tests should always pass
542542
when each individual commit lands on the master branch.
543543

544-
### Getting Approvals for Your Pull Request
544+
### Getting approvals for your pull request
545545

546546
A Pull Request is approved either by saying LGTM, which stands for
547547
"Looks Good To Me", or by using GitHub's Approve button.
@@ -554,7 +554,7 @@ After you push new changes to your branch, you need to get
554554
approval for these new changes again, even if GitHub shows "Approved"
555555
because the reviewers have hit the buttons before.
556556

557-
### CI Testing
557+
### CI testing
558558

559559
Every Pull Request needs to be tested
560560
to make sure that it works on the platforms that Node.js
@@ -564,7 +564,7 @@ Only a Collaborator can start a CI run. Usually one of them will do it
564564
for you as approvals for the Pull Request come in.
565565
If not, you can ask a Collaborator to start a CI run.
566566

567-
### Waiting Until the Pull Request Gets Landed
567+
### Waiting until the pull request gets landed
568568

569569
A Pull Request needs to stay open for at least 48 hours from when it is
570570
submitted, even after it gets approved and passes the CI. This is to make sure
@@ -573,12 +573,12 @@ collaborators may decide it doesn't need to wait. A Pull Request may well take
573573
longer to be merged in. All these precautions are important because Node.js is
574574
widely used, so don't be discouraged!
575575

576-
### Check Out the Collaborator Guide
576+
### Check out the collaborator guide
577577

578578
If you want to know more about the code review and the landing process, see the
579579
[Collaborator Guide][].
580580

581-
### Appendix: Subsystems
581+
### Appendix: subsystems
582582

583583
* `lib/*.js` (`assert`, `buffer`, etc.)
584584
* `build`

0 commit comments

Comments
 (0)