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

124 Commits

Author SHA1 Message Date
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
Myles Borins
e9545e6f20 doc: clarify who may land on an LTS staging branch
Current language is a bit confusing

PR-URL: https://github.com/nodejs/node/pull/24465
Refs: https://github.com/nodejs/node/pull/24344#issuecomment-439658596
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2018-11-22 06:06:54 +01:00
Rich Trott
7cc3b1eac5 doc: revise author ready explanation
Improve the `author ready` text in the COLLABORATOR_GUIDE for
scannability, readability, etc.

PR-URL: https://github.com/nodejs/node/pull/24558
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2018-11-21 11:48:18 -08:00
Rich Trott
0759b57d7e doc: edit COLLABORATOR_GUIDE.md on closing issues
Make the COLLABORATOR_GUIDE.md text on closing issues clearer. (Make it
clear that all the text refers to issues *and* pull requests, etc.)

PR-URL: https://github.com/nodejs/node/pull/24477
Reviewed-By: Weijia Wang <starkwang@126.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2018-11-21 06:09:31 -08:00
Rich Trott
282c5cfc27 doc: simplify first-time contributors section of Collaborator Guide
PR-URL: https://github.com/nodejs/node/pull/24387
Reviewed-By: Ouyang Yadong <oyydoibh@gmail.com>
Reviewed-By: Weijia Wang <starkwang@126.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2018-11-17 18:49:22 -08:00
Charalampos Fanoulis
ef3691a18b doc: update collaborator guide with LTS labels
PR-URL: https://github.com/nodejs/node/pull/24379
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2018-11-15 16:07:50 -08:00
Rich Trott
c1d18a0728 doc: clarify issues and pull requests guidance
Removed the "Managing Issues and Pull Requests" header as "managing" is
unclear in this context.

Useful information from the section was retained as an introductory
paragraph for the "Issues and Pull Requests" section. Vague terminology
(e.g., "full responsibility") was removed.

PR-URL: https://github.com/nodejs/node/pull/24316
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Weijia Wang <starkwang@126.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2018-11-13 22:14:42 -08:00
Rich Trott
7d12fce465 doc: revise COLLABORATOR_GUIDE.md
Simplify text/content.

PR-URL: https://github.com/nodejs/node/pull/23990
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2018-11-02 00:24:10 -07:00
Jagannath Bhat
67d74e400b doc: improve COLLABORATOR_GUIDE
PR-URL: https://github.com/nodejs/node/pull/23977
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2018-11-01 19:05:59 -07:00
James M Snell
f14274714d
meta: clarify fast-track approval
Refs: https://github.com/nodejs/node/pull/23725#issuecomment-431202936

PR-URL: https://github.com/nodejs/node/pull/23744
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2018-10-19 07:47:22 -07:00
Refael Ackermann
fc0da7f6b4 doc,meta: assign PR semantics
PR-URL: https://github.com/nodejs/node/pull/23292
Refs: https://github.com/nodejs/node/pull/23249
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2018-10-13 18:46:08 -04:00
Refael Ackermann
39ae000429 doc,meta: refresh wording in colab guide
PR-URL: https://github.com/nodejs/node/pull/23292
Refs: https://github.com/nodejs/node/pull/23249
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2018-10-13 18:46:08 -04:00
Rich Trott
d4ce144b0a doc: rewrite consensus seeking in guide
Rewrite the Consensus Seeking section of the Collaborators Guide for
easier reading, more clarity, shorter sentences, less passive voice,
etc.

PR-URL: https://github.com/nodejs/node/pull/23349
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
2018-10-11 10:02:51 -07:00
Vse Mozhet Byt
1a18e3572e doc: update author-ready label terms
PR-URL: https://github.com/nodejs/node/pull/23249
Refs: https://github.com/nodejs/node/pull/22255
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
2018-10-07 11:58:08 +03:00
Rich Trott
124a8e2123 doc: shorten pull request wait time to 48 hours
Currently, we have a 72 rule for how many hours a pull request should
be left open at a minimum. Reduce that time to 48 hours.

PR-URL: https://github.com/nodejs/node/pull/23082
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
2018-10-06 15:32:51 -07:00
Rich Trott
2f117e1cd8 doc: leave pull requests open for 72 hours
Currently, we have a 48/72 rule for how many hours a pull request should
be left open at a minimum. Unfortunately, whether a pull request should
be left open for 48 or 72 hours is often unclear. The 72 hours is
required if it is a weekend. If I open a pull request on a Friday
morning, does it need to stay open 48 hours or 72 or something in
between? Does it matter if I'm in one time zone or another?

The 48/72 rule predates our fast-tracking process. Given the ability to
fast-track trivial pull requests, there should be little disadvantage to
leaving significant changes open for 72 hours instead of 48 hours, and
arguably considerable advantage in terms of allowing people sufficient
time to review things.

So to simplify, standardize on 72 hours. Weekend or not, 72 hours. Easy.

PR-URL: https://github.com/nodejs/node/pull/22275
Reviewed-By: John-David Dalton <john.david.dalton@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ben Coe <bencoe@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: João Reis <reis@janeasystems.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
2018-10-04 16:32:39 -07:00
Franziska Hinkelmann
af522c1440 doc: clarify assigning issues to the TSC
PR-URL: https://github.com/nodejs/node/pull/22759
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
2018-10-03 10:32:27 -07:00
Richard Lau
9b34dfed76 doc: remove recommendation to use node-eps
https://github.com/nodejs/node-eps has been archived and new proposals
can no longer be opened there. Remove the corresponding recommendation
to use it.

PR-URL: https://github.com/nodejs/node/pull/23148
Refs: https://github.com/nodejs/TSC/issues/335
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
2018-10-02 07:32:10 +02:00
Rich Trott
884dbe9b7f doc: update guide for assert team
Update the Collaborator Guide to use the assert team for notifications
on assert module issues and pull requests.

PR-URL: https://github.com/nodejs/node/pull/23085
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2018-09-26 18:58:19 -07:00
cjihrig
56599a8863
doc: edit fast-tracking section
PR-URL: https://github.com/nodejs/node/pull/23059
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2018-09-26 09:23:34 -04:00
Refael Ackermann
938b2698e3 doc: improve instruction to purple merge
PR-URL: https://github.com/nodejs/node/pull/23007
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
2018-09-26 05:42:03 +02:00
Rich Trott
b01e617dcc doc: require two approvals to land changes
Currently, changes require approval by one Collaborator in most cases.
However there are situations where two approvals are required. For
example, breaking changes require two approvals from TSC members. And
fast-tracking a request requires two approvals.

Additionally, although only one approval is strictly required, in
practice, we nearly always seek a second approval when there is only
one.

Lastly, concerns have been raised about (perhaps unintentionally) gaming
the one-approval system by suggesting a change to someone else, and then
approving that change when the user submits a pull request. This
resolves (or at least mitigates) that concern.

Fixes: https://github.com/nodejs/node/issues/19564

PR-URL: https://github.com/nodejs/node/pull/22255
Refs: https://github.com/nodejs/node/issues/19564
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Reviewed-By: Bryan English <bryan@bryanenglish.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: John-David Dalton <john.david.dalton@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ujjwal Sharma <usharma1998@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
2018-09-24 22:14:55 -07:00
Ruben Bridgewater
54af9738b9 doc: specify fast-tracking
Currently the documentation is not specific how fast-tracking should
be applied. This specifies exactly how things should be done to prevent
confusion.

PR-URL: https://github.com/nodejs/node/pull/22929
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: John-David Dalton <john.david.dalton@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Weijia Wang <starkwang@126.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Yuta Hiroto <hello@hiroppy.me>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
2018-09-21 05:34:10 +02:00
Michael Dawson
5cccc5545b doc: add reference to guide for N-API additions
Add reference to guide with requirements/principles
for accepting additions to N-API.

PR-URL: https://github.com/nodejs/node/pull/22593
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2018-09-13 15:38:56 -04:00
Denys Otrishko
317b894b12
doc: add GitHub email set up link to COLLABORATOR_GUIDE
PR-URL: https://github.com/nodejs/node/pull/22525
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2018-08-26 14:40:46 +01:00
Vse Mozhet Byt
c75f36f105 doc: replace deprecated CI job
`node-test-pull-request-lite` CI job is deprecated now and
https://ci.nodejs.org/job/node-test-pull-request-lite/ has this note:
"DEPRECATED: please use the node-test-pull-request-lite-pipeline job".

PR-URL: https://github.com/nodejs/node/pull/21938
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: João Reis <reis@janeasystems.com>
2018-07-26 00:32:10 +03:00
Rich Trott
f5a2167eb5 doc: add node-test-commit-custom-suites to docs
Add node-test-commit-custom-suites to the COLLABORATOR_GUIDE.

Refs: https://github.com/nodejs/node/pull/21909#issuecomment-406796234

PR-URL: https://github.com/nodejs/node/pull/21927
Reviewed-By: Lance Ball <lball@redhat.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2018-07-24 13:29:07 -07:00
Rich Trott
e406cca5c3
doc: make minor improvements to collab guide
PR-URL: https://github.com/nodejs/node/pull/21862
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2018-07-18 17:52:59 +02:00
Rich Trott
0a78f7d622 doc: improve guide text for CI runs
Make the text about CI runs in the COLLABORATOR_GUIDE more concise. Add
information about Resume Build which should generally be preferred over
Rebuild.

PR-URL: https://github.com/nodejs/node/pull/21645
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2018-07-05 16:04:28 -07:00
Rich Trott
b6b019f37b doc: use imperative in COLLABORATOR_GUIDE
Instead of wording the paragraph about communicating deprecations with
the ecosystem as if it were directed at the ecosystem, write it as in
imperative directed at the collaborator, since that is the audience for
the COLLABORATOR_GUIDE. Instead of assuring the reader that a best
effort will be made, instruct the reader to make the effort to
communicate with the ecosystem.

PR-URL: https://github.com/nodejs/node/pull/21340
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2018-06-17 21:33:39 -07:00
Rich Trott
2749460ddc doc: make Deprecation cycle explanation more brief
The Deprecation cycle explanation in the COLLABORATOR_GUIDE.md file is
now more concise.

PR-URL: https://github.com/nodejs/node/pull/21303
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Minwoo Jung <minwoo@nodesource.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
2018-06-14 21:20:53 -07:00
Rich Trott
4c166935ae doc: trim deprecation level definition text
Provide more concise explanations of the deprecation levels in
COLLABORATOR_GUIDE.md.

PR-URL: https://github.com/nodejs/node/pull/21241
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Yuta Hiroto <hello@hiroppy.me>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
Reviewed-By: Ujjwal Sharma <usharma1998@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Weijia Wang <starkwang@126.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
2018-06-12 21:04:21 -07:00
Rich Trott
df511c6195 doc: improve _Deprecation_ definition
* Use definition from Wikipedia. Provide link.
* Use italics for "words-as-words".
* Simplify sentence. ("Deprecation is..." rather than "Deprecation
  refers to...".)

PR-URL: https://github.com/nodejs/node/pull/20788
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2018-05-19 20:53:47 -07:00
Vse Mozhet Byt
59f71ea4dd
doc: fix typo in COLLABORATOR_GUIDE.md
PR-URL: https://github.com/nodejs/node/pull/20742
Refs: https://github.com/nodejs/node/pull/20740
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2018-05-18 16:06:31 +02:00
Rich Trott
c7831bb206 doc: sort references in ASCII order
The references in the COLLABORATOR_GUIDE appear to be in no particular
order. Sort in ASCII order.

PR-URL: https://github.com/nodejs/node/pull/20790
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2018-05-17 11:41:31 -07:00
Vse Mozhet Byt
0452f1152c doc: update "Who to cc..." in COLLABORATOR_GUIDE
Some of the mentioned files seem to be moved or renamed.

PR-URL: https://github.com/nodejs/node/pull/20564
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ujjwal Sharma <usharma1998@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2018-05-08 01:48:10 +03:00
Ruben Bridgewater
28a54cb83a
doc: clearer doc-only deprecations
Explicitely mention that a documentation only deprecation does not
always imply that it will be staged for deprecation in a future
Node.js major release. It is mainly there to tell developers that
a specific API should be avoided.

PR-URL: https://github.com/nodejs/node/pull/20381
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2018-05-07 14:20:47 +02:00
Rich Trott
ca80551640 doc: remove "has been known" tentativeness
Remove unnecessary "has been known to" tentativeness from
COLLABORATOR_GUIDE.md. "has been known to" is an awkward replacement for
"can" or "might" or "sometimes does" or "does". Pick the right one and
use it.

PR-URL: https://github.com/nodejs/node/pull/20412
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2018-04-30 10:44:39 -07:00