0
0
mirror of https://github.com/nodejs/node.git synced 2024-11-29 23:16:30 +01:00
Commit Graph

161 Commits

Author SHA1 Message Date
Richard Lau
f3a509720b
doc: document "Resume Build" limitation
Compiled binaries for fanned CI builds on Windows and ARM are only kept
for seven days.

PR-URL: https://github.com/nodejs/node/pull/30604
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2019-11-25 19:15:03 -05:00
Denys Otrishko
c8d00d9ed0 doc: explain GIT_REMOTE_REF in COLLABORATOR_GUIDE
PR-URL: https://github.com/nodejs/node/pull/30371
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-11-20 16:58:07 -08:00
Richard Lau
3e2b68aff3
doc: document timed out Travis CI builds
PR-URL: https://github.com/nodejs/node/pull/30469
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
2019-11-17 14:27:29 -05:00
Rich Trott
e44d73f011 doc,meta: allow Travis results for doc/comment changes
Permit the use of Travis CI results for pull requests that only change
documentation or comments. This also removes
node-test-pull-request-lite-pipeline from the documentation. Efforts to
move all CI jobs to pipelines have stalled and it's not clear that our
current Jenkins admins are enthusiastic about pipelines.

PR-URL: https://github.com/nodejs/node/pull/30330
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2019-11-10 07:55:48 -08:00
Rich Trott
8fa4abdf23 doc,meta: prefer aliases and stubs over Runtime Deprecations
Avoid Runtime Deprecations when an alias or a stub/no-op will suffice.
An alias or stub will have lower maintenance costs for end users.

Refs: https://github.com/nodejs/node/pull/29989#issuecomment-545427805

PR-URL: https://github.com/nodejs/node/pull/30153
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2019-10-30 06:46:34 -07:00
Michael Dawson
48a1f75a90 doc: remove reference to stale CITGM job
Remove reference to job that is out of date, has not
been run for a long time and likely does not work
properly.

Refs: https://github.com/nodejs/citgm/issues/741

PR-URL: https://github.com/nodejs/node/pull/29774
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-10-02 16:13:10 -07:00
Nick Schonning
e2dcbf1c32 doc: use consistent unordered list style
Convert to asterisks when there are mixed styles in document.
Addresses Markdownlint MD004 rule

PR-URL: https://github.com/nodejs/node/pull/29516
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2019-09-16 11:24:54 -07:00
Nick Schonning
c929b15d1d doc: space around lists
Address markdownlint rule MD032.
Flagged a few mixed list styles.

PR-URL: https://github.com/nodejs/node/pull/29467
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2019-09-09 16:45:24 -07:00
Nick Schonning
61d973affb doc: escape elements swallowed as HTML in markdown
Addresses Markdownlint MD033 issues.
Altering changlog should usually be avoided, but they don't render
currently.

PR-URL: https://github.com/nodejs/node/pull/29374
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2019-09-02 07:46:45 +02:00
Rich Trott
8030ca5b9e doc: remove instructions to post CI links
Remove instructions (in the Collaborator Guide) to post CI links. The
bot does that now.

PR-URL: https://github.com/nodejs/node/pull/28248
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2019-06-18 09:35:11 -07:00
Rich Trott
6bc2ab19e9
doc: remove "How is an LTS release cut?" section
The release process is in the Release plan, linked earlier in the doc.
Don't include information here because duplicated information is likely
to drift apart, resulting in contradictions and a lack of clarity about
which document is correct. (I think the text removed is already
out-of-date. I could be wrong, and it doesn't much matter, as it should
be removed anyway.) It's also not entirely clear what the
utility/relevance of this information is in this particular document.

PR-URL: https://github.com/nodejs/node/pull/26955
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2019-03-30 12:30:48 +01:00
Rich Trott
6342af7ebd doc: edit "How Can I Help?" in Collaborator Guide
Edit the "How Can I Help?" section of the Collaborator Guide to keep
sentences simple, short, and direct.

PR-URL: https://github.com/nodejs/node/pull/26895
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-03-26 16:19:27 -07:00
Rich Trott
683e01b250 doc: edit LTS material in Collaborator Guide
* Rewrite some material for simplicity and directness.
* Remove outdated LTS material in the Collaborator Guide. (For example,
  refers to LTS WG for things that are now handled by the Release WG.)
* Minor change to text about force pushing (s/minimize/reduce/).

PR-URL: https://github.com/nodejs/node/pull/26845
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2019-03-23 19:56:31 -07:00
Rich Trott
a7fdb42c1a doc: remove How Does LTS Work section from Collaborator Guide
The How Does LTS Work section duplicates material in the release plan,
to which there is already a link in the doc. Unfortunately, it has gone
out of sync with the release plan, resulting in incorrect material being
in the Collaborator Guide. (The Release WG needs to approve certain
changes, not LTS WG as the guide currently says. It used to be the LTS
WG, but that changed.)

Instead of duplicating material in the Collaborator Guide and risking
that the two documents contradict each other again, instruct the reader
to refer to the release plan as the canonical source of information.

PR-URL: https://github.com/nodejs/node/pull/26723
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2019-03-19 20:30:57 -07:00
Rich Trott
4265021085 doc: condense LTS material in Collaborator Guide
Edit and condense the "What is LTS?" section of the Collaboroator Guide.

PR-URL: https://github.com/nodejs/node/pull/26722
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2019-03-19 20:27:54 -07:00
Rich Trott
bab5544476 doc: simplify force-push guidelines
Edit the guildelines for force-pushing in Collaborator Guide. There are
no policy changes, but the material is simplified a bit and the
sentences are now shorter.

PR-URL: https://github.com/nodejs/node/pull/26699
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-03-17 23:16:53 -07:00
Rich Trott
22de2cfb71 doc: simplify Troubleshooting text
In the Troubleshooting section of the Collaborator Guide, there is one
particularly lengthy and difficult-to-understand sentence. Make it
shorter and more clear.

PR-URL: https://github.com/nodejs/node/pull/26652
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2019-03-15 22:14:10 -07:00
Rich Trott
ee4f32f27c doc: update copy/paste error message in Troubleshooting
In the Troubleshooting portion of the Collaborator Guide, there is a
copy/pasted error message. The message is out of date. More recent git
contains a more concise and clear message. Update the text to reflect
the current git error message.

PR-URL: https://github.com/nodejs/node/pull/26652
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2019-03-15 22:14:08 -07:00
Rich Trott
107c95da0d doc: edit "Technical How-To" section of guide
Edit the "Technical How-To" section of the Collaborator Guide. Keep
wording simple and direct.

PR-URL: https://github.com/nodejs/node/pull/26601
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
2019-03-13 20:05:20 -07:00
Rich Trott
2e2670a207 doc: edit "Using git-node" section of Guide
Edit the "Using git-node" section of the Collaborator Guide. Make
sentences concise and clear, reduce use of passive voice, etc.

PR-URL: https://github.com/nodejs/node/pull/26580
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Masashi Hirano <shisama07@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
2019-03-11 13:42:04 -07:00
Rich Trott
cc2c07ce08 doc: edit Landing Pull Requests
Edit the Landing Pull Requests section of the Collaborators Guide for
brevity and clarity.

PR-URL: https://github.com/nodejs/node/pull/26536
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Masashi Hirano <shisama07@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2019-03-10 21:12:58 -07:00
Rich Trott
b4e24e3c96 doc: remove tsc-review
The tsc-review label is ineffective. It almost always gets ignored.
Remove it. When requiring TSC attention, people should @-mention the
TSC GitHub team.

PR-URL: https://github.com/nodejs/node/pull/26506
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-03-09 22:25:19 -08:00
Rich Trott
ed465eb595 doc: edit "Involving the TSC"
Edit the "Involving the TSC" section of the Collaborator Guide to reduce
passive voice, make things concise, etc.

PR-URL: https://github.com/nodejs/node/pull/26481
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Yuta Hiroto <hello@hiroppy.me>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2019-03-08 14:38:35 -08:00
Rich Trott
7ffbb4606f doc: standardize on End-of-Life capitalization
Use "End-of-Life" everywhere and not "End-of-life" or "End-Of-Life".

PR-URL: https://github.com/nodejs/node/pull/26442
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
2019-03-06 15:50:43 -08:00
Rich Trott
05606c6690 doc: edit deprecation section of Collaborator Guide
Edit the last few paragraphs of the Collaborator Guide section on
deprecations.

PR-URL: https://github.com/nodejs/node/pull/26419
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
2019-03-06 13:12:24 -08:00
Rich Trott
d773311c33 doc: edit deprecation identifier info in Collaborator Guide
Edit the deprecation identifier material in the Collaborator Guide for
simplicity and clarity.

PR-URL: https://github.com/nodejs/node/pull/26372
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
2019-03-03 14:07:14 -08:00
Rich Trott
04d5c1b8fd doc: revise deprecation semverness info in Collaborator Guide
Simplify and clarify deprecation semverness information in the
Collaborator Guide. Unlike some of the other changes I've made lately,
this one is not merely cosmetic. It changes information about how to
handle deprecations vis-a-vis SemVer. The revised conventions take
advange of `notable change` labels etc. instead of suggesting that
doc-deprecations be treated as `semver-minor`. The idea that a
deprecation is a new feature seems incorrect from a SemVer perspective,
but probably made sense at the time the text was written if we weren't
yet using `notable change` etc.

PR-URL: https://github.com/nodejs/node/pull/26232
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-02-27 23:42:35 -08:00
Rich Trott
70b13c28c9 doc: revise deprecation level explanations in Collaborator Guide
Revise deprecation level explanations for scanability and ease of
understanding.

PR-URL: https://github.com/nodejs/node/pull/26197
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Yuta Hiroto <hello@hiroppy.me>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
2019-02-20 22:06:47 -08:00
Rich Trott
0ebff65b65 doc: remove deprecation definition in Collaborator Guide
The Collaborator Guide links to a definition of "deprecation" but also
quotes it extensively. Remove the extensive quotes.

PR-URL: https://github.com/nodejs/node/pull/26157
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2019-02-18 18:45:06 -08:00
Rich Trott
5bb7764b68 doc: consolidate N-API material in Collaborator Guide
Consolidate the N-API material in the Collaborator Guide to be succinct
and direct.

PR-URL: https://github.com/nodejs/node/pull/26094
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Bryan English <bryan@bryanenglish.com>
2019-02-16 15:30:45 -08:00
Rich Trott
3f9beabe05 doc: edit N-API introductory material in Collaborator Guide
Use shorter, clearer sentences. Remove passive voice and personal
pronouns.

PR-URL: https://github.com/nodejs/node/pull/26051
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2019-02-13 23:36:14 -08:00
Rich Trott
016c7b9c32 doc: revise Introducing New Modules
Revise "Introducing New Modules" in the Collaborator Guide:

* Improve clarity.
* Remove passive voice.
* Keep sentences short for ease of reading/scanning.

PR-URL: https://github.com/nodejs/node/pull/25975
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2019-02-08 20:46:04 -08:00
Rich Trott
cf43846e25 doc: revise Collaborator Guide on reverting
Revise the "Reverting commits" section of the Collaborator Guide. Reduce
passive voice. Increase clarity.

PR-URL: https://github.com/nodejs/node/pull/25942
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2019-02-06 20:20:34 -08:00
Rich Trott
3fe9267592 doc: improve doc on unintended breaking changes
Improve the material in the Collaborator Guide on unintended breaking
changes.

PR-URL: https://github.com/nodejs/node/pull/25887
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
2019-02-04 10:32:49 -08:00
Rich Trott
28c0f84a69 doc: remove redundant LTS/Current information in Collaborator Guide
Remove bullet points about how breaking changes are handled in Current
and LTS branches.

* This information is covered in
  https://github.com/nodejs/Release#release-plan.
* Having it here and in the above link means that the two may get out of
  sync, resulting in confusion.
* The above link appears later in the doc in the LTS section.
* Most Collaborators should not land *anything* in LTS branches and will
  almost never have a reason to land things into Current branches. They
  land stuff on the master branch. Adding this material here is
  confusing because it implies that Collaborators do land stuff on those
  branches. Save talk about those branches and how they're managed for
  later in the LTS section where it can be made clear that most
  Collaborators should not be landing code there anyway.

PR-URL: https://github.com/nodejs/node/pull/25842
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2019-02-01 23:44:34 -08:00
Rich Trott
43bba40717 doc: remove outdated COLLABORATOR_GUIDE sentence about breaking changes
The TSC has delegated authority over LTS and Current branches to the
Release WG. Remove the bullet point about TSC having authority to
determine that a breaking change is necessary on LTS and Current release
branches. Retaining that authority would require de-chartering the
Release WG.

Fixes: https://github.com/nodejs/TSC/issues/660

PR-URL: https://github.com/nodejs/node/pull/25780
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
2019-01-30 21:44:59 -08:00
Rich Trott
aa8fcee7ce doc: revise breaking changes material in COLLABORATOR_GUIDE
* Remove unnecessary paragraph explaining why Current and LTS have
  stability guarantees that master branch does not. (Leave material
  explaining what those stability guarantees are.)
* Upgrade advisory and passive "Collaborators should take significant
  care" to more direct "Take significant care".

PR-URL: https://github.com/nodejs/node/pull/25730
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2019-01-28 16:44:24 -08:00
Rich Trott
ab76eac301 doc: revise "Breaking Changes to Internal Elements"
Revise the "Breaking Changes to Internal Elements" section of
COLLABORATOR_GUIDE.md. Simplify wording, shorten sentences, and remove
redundant material.

PR-URL: https://github.com/nodejs/node/pull/25190
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
2018-12-26 08:13:40 -08:00
Rich Trott
966a2df0f6 doc: revise "Breaking Changes and Deprecations"
Revise the "Breaking Changes and Deprecations" section of the
Collaborator Guide. Simplify the text. Remove redundant text. The
"Deprecations" section is thorough and linked to from this section.

PR-URL: https://github.com/nodejs/node/pull/25116
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2018-12-21 09:56:20 -08:00
Rich Trott
3edc1c917b doc: revise "Breaking Changes" section of Collaborator Guide
Simplify material about TSC approval for breaking changes. Omit
extraneous material explaining that purely additive changes are not
breaking changes.

PR-URL: https://github.com/nodejs/node/pull/25071
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Yuta Hiroto <hello@hiroppy.me>
Reviewed-By: James M Snell <jasnell@gmail.com>
2018-12-17 18:49:27 -08:00
Rich Trott
9f37f9c439 doc: revise internal vs. public API in Collaborator Guide
Make the Collaborator Guide section "Internal vs. Public API" more
concise and clear. Remove repetition. Clarify some ambiguity.
wordy, repetitive, and somewhat

PR-URL: https://github.com/nodejs/node/pull/24975
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
2018-12-13 17:29:57 -08:00
Rich Trott
2f75eed1aa doc: update Useful CI Jobs section of Collaborator Guide
Revise the Useful CI Jobs section of the Collaborator Guide to be more
clear and concise.

PR-URL: https://github.com/nodejs/node/pull/24916
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
2018-12-11 14:14:22 -08:00
Ruben Bridgewater
4aabd7ed64 doc: simplify author ready
The label should be applied early on. Otherwise there is little
benefit using this label at all.

PR-URL: https://github.com/nodejs/node/pull/24893
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
2018-12-09 20:03:27 -08:00
Rich Trott
951b1c3e09 doc: update "Testing and CI" in Collaborator Guide
Update "Testing and CI" in the Collaborator Guide. Remove redundant
material. Shorten sentences. Remove incorrect material. (Specifically,
we don't require test cases to be included in all pull requests that
modify exectuable code. For example, if code is refactored, then passing
existing tests is sufficient.)

PR-URL: https://github.com/nodejs/node/pull/24884
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2018-12-08 22:43:04 -08:00
Rich Trott
07018b7c1a doc: revise Waiting for Approvals documentation
Revise the Waiting for Approvals section of the Collaborator Guide. Keep
sentences short and clear. Split long paragraphs into shorter
paragraphs.

PR-URL: https://github.com/nodejs/node/pull/24845
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2018-12-06 22:17:03 -08:00
Rich Trott
e9a1fee818 doc: use author's titles for linked resources
Update Collaborator Guide links to use the title of the item being
linked.

PR-URL: https://github.com/nodejs/node/pull/24837
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Yuta Hiroto <hello@hiroppy.me>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2018-12-04 18:20:50 -08:00
Rich Trott
83ee137c45 doc: revise code review guidelines
Revise the Code Reviews section of the Collaborator Guide to remove
redundant statements, simplify text and structure for easier
comprehension, and remove material that does not reflect current
practices.

PR-URL: https://github.com/nodejs/node/pull/24790
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
2018-12-04 13:29:03 -08:00
Rich Trott
2e03b76bcf doc: streamline Accepting Modifications in Collaborator Guide
Editing a sentence I missed simplifying in the last pass on that
section.

PR-URL: https://github.com/nodejs/node/pull/24807
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2018-12-03 10:41:13 -08:00
Rich Trott
7d18e922ab doc: revise accepting-modifications in guide
Revise the "Accepting Modifications" section of the Collaborator Guide.

PR-URL: https://github.com/nodejs/node/pull/24650
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
2018-11-27 21:59:01 -08:00
Rich Trott
92986837ff doc: revise handling-own-pull-requests text
Simplify and clarify the text of the COLLABORATORS_GUIDE where handling
one's own pull requests is concerned.

PR-URL: https://github.com/nodejs/node/pull/24583
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Yuta Hiroto <hello@hiroppy.me>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2018-11-25 16:52:59 -08:00