Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: simplify text in pull-requests.md #30458

Merged
merged 9 commits into from Nov 15, 2019
Merged

Conversation

@Trott
Copy link
Member

Trott commented Nov 13, 2019

Mostly, this replaces "It is recommended to do X" with "Do X."

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
@Trott Trott added the author ready label Nov 13, 2019
SimonSchick and others added 3 commits Nov 10, 2019
PR-URL: #30346
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Add documentation for the `lookup` option.

PR-URL: #30353
Fixes: #30171
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Fixes: #30211
PR-URL: #30356
Reviewed-By: Steven R Loomis <srloomis@us.ibm.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Copy link
Member

BridgeAR left a comment

LGTM. I would like to point out though that the former description of step 4. is easier for me to follow as a non-native speaker.

ronag and others added 3 commits Aug 8, 2019
PR-URL: #29053
Reviewed-By: Anna Henningsen <anna@addaleax.net>
PR-URL: #29053
Reviewed-By: Anna Henningsen <anna@addaleax.net>
PR-URL: #30249
Fixes: #30237
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
@Trott

This comment has been minimized.

Copy link
Member Author

Trott commented Nov 14, 2019

LGTM. I would like to point out though that the former description of step 4. is easier for me to follow as a non-native speaker.

Let's fix this to maintain that ease-of-understanding. Is this better?:

It is a best practice to keep your changes as logically grouped
as possible within individual commits. There is no limit to the number of
commits any single Pull Request may have, and many contributors find it easier
to review changes that are split across multiple commits.

Trott added 3 commits Nov 12, 2019
The "maintenance is supported by" stuff in BUILDING.md is unclear. It
seems unnecessary so I propose removing it.

I don't understand what it means to, in this context, support
maintenance. Does it mean that you simply do the maintenance? Does that
mean it really just means "maintain"? Do we really mean that we mantain
support, rather than support maintenance?

That information does not seem necessary to include. I'm not sure it's
meaningful. With (for example) Windows, is it accurate to say that the
Node.js core team maintains support for it? Or is it accurate to say
that support is maintaned by smaller groups or individuals within the
Node.js core team?  Both could be considered accurate. So is the
difference meaningful?

I think the more important elements of determinig tier support are the
other listed elements.

PR-URL: #30365
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
The statement that tests for tier 1 platforms are run on multiple
variants is not true. We usually only run on one variant of macOS.
Remove "multiple", which simplifies and clarifies the statements anyway.

PR-URL: #30366
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Mostly, this replaces "It is recommended to do X" with "Do X."

PR-URL: #30458
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@Trott

This comment has been minimized.

Copy link
Member Author

Trott commented Nov 15, 2019

Landed in 794d8be

@Trott Trott merged commit 794d8be into nodejs:master Nov 15, 2019
1 check passed
1 check passed
Travis CI - Branch Build Passed
Details
MylesBorins added a commit that referenced this pull request Nov 17, 2019
Mostly, this replaces "It is recommended to do X" with "Do X."

PR-URL: #30458
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@BridgeAR BridgeAR mentioned this pull request Nov 19, 2019
targos added a commit that referenced this pull request Dec 1, 2019
Mostly, this replaces "It is recommended to do X" with "Do X."

PR-URL: #30458
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@BethGriggs BethGriggs mentioned this pull request Dec 9, 2019
MylesBorins added a commit that referenced this pull request Dec 17, 2019
Mostly, this replaces "It is recommended to do X" with "Do X."

PR-URL: #30458
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@BethGriggs BethGriggs mentioned this pull request Dec 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
You can’t perform that action at this time.