summaryrefslogtreecommitdiff
path: root/COLLABORATOR_GUIDE.md
AgeCommit message (Collapse)Author
2017-10-12doc: exempt test/doc only changes from 48-hr ruleAnna Henningsen
If a change affects only specific parts of the tests and or documentation, and in particular not of the runtime code itself, it should often be okay to land it early. The primary goal of the 48-hour rule is to ensure that people who are invested in certain parts of Node have a reasonable chance to weigh in based on their usage of Node; if the API is not touched in a change, that is arguably much less of an issue. In particular, this: - Should help avoid excessive nitpicking. - Helps newcomers, since their first PRs often touch only those areas and a direct success is very motivating. - Helps with the amount of pull requests created by events such a Code & Learn. PR-URL: https://github.com/nodejs/node/pull/16135 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2017-10-01doc: edit COLLABORATORS_GUIDE.md for readabilityRich Trott
Changes include: * add words-as-words italics * remove scare quotes and excessive italics-for-emphasis * change "is considered to be" and similar to "is" * change "is X and not not-X" formulations to just "is X" * change "any and all" to "all" * remove "sky is blue" paragraph about breaking changes * general reduction in wordiness PR-URL: https://github.com/nodejs/node/pull/15629 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2017-09-30doc: fix links in some intra-repository docsVse Mozhet Byt
PR-URL: https://github.com/nodejs/node/pull/15675 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2017-09-25doc: ctc -> tsc in collab guideBryan English
PR-URL: https://github.com/nodejs/node/pull/15590 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.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: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Refael Ackermann <refack@gmail.com>
2017-09-12meta: allow vague objections to be dismissedJames M Snell
Explicitly allow vague objections to change requests to be dismissed if requests for clarification go unanswered PR-URL: https://github.com/nodejs/node/pull/15233 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Jan Krems <jan.krems@gmail.com> Reviewed-By: Ryan Graham <r.m.graham@gmail.com> Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Timothy Gu <timothygu99@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Ron Korving <ron@ronkorving.nl> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
2017-08-29meta: merge TSC and CTC back into a single bodyJames M Snell
PR-URL: https://github.com/nodejs/node/pull/14973 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com> Reviewed-By: Shigeki Ohtsu <ohtsu@ohtsu.org> Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com>
2017-08-28meta: considerations for new core modulesJames M Snell
PR-URL: https://github.com/nodejs/node/pull/15022 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com> Reviewed-By: Andreas Madsen <amwebdk@gmail.com>
2017-08-17doc: explain what to do if git push is rejectedRich Trott
In COLLABORATOR_GUIDE.md, explain what to do if `git push upstream master` is rejected. PR-URL: https://github.com/nodejs/node/pull/14848 Fixes: https://github.com/nodejs/node/issues/12628 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>
2017-05-19doc: add additional useful ci job to listMichael Dawson
PR-URL: https://github.com/nodejs/node/pull/13086 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>
2017-05-16doc: document method for reverting commitsGibson Fahnestock
PR-URL: https://github.com/nodejs/node/pull/13015 Fixes: https://github.com/nodejs/node/issues/12979 Refs: https://github.com/nodejs/node/pull/4679#issuecomment-172421320 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2017-05-12doc: update COLLABORATOR_GUIDE.mdmorrme
PR-URL: https://github.com/nodejs/node/pull/12555 Fixes: https://github.com/nodejs/node/issues/12021 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2017-04-30doc: fix formatting of TOCRefael Ackermann
PR-URL: https://github.com/nodejs/node/pull/12731 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com> Reviewed-By: Timothy Gu <timothygu99@gmail.com>
2017-04-21doc: add suggestion to use --3wayMichael Dawson
The CI seems to do a 3way merge so it is possible that even though the CI passed, the existing git am command may fail. Add text to suggest how to handle this by adding the --3way option. PR-URL: https://github.com/nodejs/node/pull/12510 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
2017-04-18doc: run tests before landing changesRich Trott
The Collaborator Guide suggests running tests after pushing changes to the main repository. Tests should be run before then so move the instructions earlier. Instructions are also simplified and re-written to not exclude Windows. PR-URL: https://github.com/nodejs/node/pull/12416 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
2017-04-18doc: avoid colloquialismRich Trott
I witnessed an English-as-a-second-language speaker puzzle over the word "borked" in our documentation today. Reword to avoid colloquialisms. It's more precise and clear this way anyway. Also reformat `Optional:` to be consistent with how it appears elsewhere in the doc. PR-URL: https://github.com/nodejs/node/pull/12417 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2017-04-17doc: s/origin/upstream/ collaborator guideAnna Henningsen
Use `upstream` to refer to `nodejs/node` instead of `origin`, because that’s the more common setup. PR-URL: https://github.com/nodejs/node/pull/12436 Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2017-04-16doc: add guide for backporting prsEvan Lucas
This guide should help answer questions for contributors that are not familiar with the backport process. PR-URL: https://github.com/nodejs/node/pull/11099 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2017-02-04doc: typographical fixes in COLLABORATOR_GUIDE.mdAnna Henningsen
Fix a typo and add a missing line break. PR-URL: https://github.com/nodejs/node/pull/11163 Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Nikolai Vavilov <vvnicholas@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
2017-02-01meta: add explicit deprecation and semver-major policyJames M Snell
* Formalizes deprecation policy * Introduces End-of-life deprecation phase to identify code to be removed * Outlines basics of internal vs. public API surface PR-URL: https://github.com/nodejs/node/pull/7964 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Trevor Norris <trev.norris@gmail.com> Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2017-01-10doc: update LTS info for current releasesEvan Lucas
The COLLABORATOR_GUIDE was still listing v0.10 and v0.12 as LTS when they are EOL now. PR-URL: https://github.com/nodejs/node/pull/10720 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2017-01-09doc: document use of Refs: for referencesGibson Fahnestock
Standardise on Refs: PR-URL: https://github.com/nodejs/node/pull/10670 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Yorkie Liu <yorkiefixer@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
2016-12-21doc: fix broken link in COLLABORATOR_GUIDE.mdEmanuel Buholzer
PR-URL: https://github.com/nodejs/node/pull/10337 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
2016-12-16doc: fix broken link in COLLABORATOR_GUIDE.mdMichael Dawson
One of the links to CONTRIBUTING.md was broken in the doc. Updated broken link to be the same as the other one in the doc that was working. PR-URL: https://github.com/nodejs/node/pull/10267 Reviewed-By: Sam Roberts <sam@strongloop.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
2016-12-06doc: remove repeated info onboarding.mdBethGriggs
COLLABORATOR_GUIDE.md and onboarding.md cover some of the same information. The aim of this commit is to remove duplicated information. PR-URL: https://github.com/nodejs/node/pull/9635 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
2016-10-19doc: add ctc-review label informationRich Trott
PR-URL: https://github.com/nodejs/node/pull/9072 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2016-10-13doc: explains why Reviewed-By is added in PRsjessicaquynh
Adds verbose reasons to the documentation on why the Reviewed-By metadata on a pull request is important. This was loosely mentioned as an issue in the referenced issue below, and answered by @addaleax. Ref: https://github.com/nodejs/node/issues/8893 PR-URL: https://github.com/nodejs/node/pull/9044 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2016-08-04meta: clarify process for breaking changesRich Trott
Fixes: https://github.com/nodejs/node/issues/7848 PR-URL: https://github.com/nodejs/node/pull/7955 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com> Reviewed-By: Julien Gilli <jgilli@nodejs.org> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Brian White <mscdex@mscdex.net> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2016-03-13collaborator_guide: clarify commit message rulesWyatt Preul
Italicize the full URL being required in metadata. PR-URL: https://github.com/nodejs/node/pull/5661 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James Snell <jasnell@gmail.com>
2016-02-22doc: update repo docs to use 'CTC'Alexis Campailla
PR-URL: https://github.com/nodejs/node/pull/5304 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2015-11-11doc: update lts description in the collaborator guideJames M Snell
PR-URL: https://github.com/nodejs/node/pull/3668 Reviewed-By: Julien Gilli <jgilli@fastmail.fm>
2015-10-28doc: add LTS info to COLLABORATOR_GUIDE.mdMyles Borins
There is currently no information in the Collaborators guide regarding LTS. This commit adds some basic copy explaining what LTS is, what is considered for LTS, and a simple way collaborators can help. Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Steven R. Loomis <srloomis@us.ibm.com> PR-URL: https://github.com/nodejs/node/pull/3442
2015-09-24doc: jenkins-iojs.nodesource.com -> ci.nodejs.orgMichał Gołębiowski
The Jenkins URL has changed from https://jenkins-iojs.nodesource.com to https://ci.nodejs.org. The former address now redirects to the latter. Some jobs has also changed names. PR-URL: https://github.com/nodejs/node/pull/2886 Reviewed-By: Rod Vagg <r@va.gg> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Roman Reiss <me@silverwind.io>
2015-08-23node: rename from io.js to nodecjihrig
This commit replaces instances of io.js with Node.js, based on the recent convergence. There are some remaining instances of io.js, related to build and the installer. Fixes: https://github.com/nodejs/node/issues/2361 PR-URL: https://github.com/nodejs/node/pull/2367 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: João Reis <reis@janeasystems.com>
2015-06-17doc: mention CI in Collaborator GuideRich Trott
Add link to Jenkins server in Collaborator Guide. PR-URL: https://github.com/nodejs/io.js/pull/1995 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2015-06-17doc: add TOC links to Collaborator GuideRich Trott
PR-URL: https://github.com/nodejs/io.js/pull/1994 Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2015-06-14doc: copyedit COLLABORATOR_GUIDE.mdRich Trott
PR-URL: https://github.com/nodejs/io.js/pull/1964 Reviewed-By: Alex Kocharin <alex@kocharin.ru> Reviewed-By: Johan Bergström <bugs@bergstroem.nu>
2015-05-18doc: update links from iojs/io.js to nodejs/io.jsFrederic Hemberger
Replaced all links in doc and comments to point to the new org. PR-URL: https://github.com/nodejs/io.js/pull/1715 Reviewed-By: Roman Reiss <me@silverwind.io>
2015-04-23doc: update branch to masterRoman Reiss
Update the remaining markdown files to refer to the master branch. PR-URL: https://github.com/iojs/io.js/pull/1511 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2015-04-16doc: Document forced pushing with gitJohan Bergström
Mention that we generally disallow forced pushes but allow it in trivial cases within 10 minutes of the original push unless the branch pushed to already has new commits. PR-URL: https://github.com/iojs/io.js/pull/1420 Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
2015-04-09doc: update curl usage in COLLABORATOR_GUIDERoman Reiss
Github now redirects the patch urls hosted on github.com, making it necessary to enable curl redirect handling to obtain patches in the merge process. Example (before and after): https://github.com/iojs/io.js/pull/1382.patch https://patch-diff.githubusercontent.com/raw/iojs/io.js/pull/1382.patch PR-URL: https://github.com/iojs/io.js/pull/1382 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2015-04-04doc: fix minor typos in COLLABORATOR_GUIDE.mdKelsey
PR-URL: https://github.com/iojs/io.js/pull/1320 Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2015-01-12doc: clarified & split up contribution docsRod Vagg
- clarified the role of "collaborators" - split out a governance doc - split out a collaborator guide - cleaned up the contributing doc - cleaned up the readme & added collaborators list PR-URL: https://github.com/iojs/io.js/pull/233 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com> Reviewed-By: Mikeal Rogers <mikeal.rogers@gmail.com> (Note: no explicit "LGTM" from Mikeal) Discussed at TC meeting 2015-01-07, agreed to push further amendments to governance to future PRs.
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-01 09:24:17 +0000