0
0
mirror of https://github.com/nodejs/node.git synced 2024-12-01 16:10:02 +01:00
Commit Graph

34 Commits

Author SHA1 Message Date
Michael Dawson
3702ae732e doc: add additional useful ci job to list
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-19 17:01:08 -04:00
Gibson Fahnestock
92f3b301ab
doc: document method for reverting commits
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-16 10:26:43 +01:00
morrme
1d5f5aa7e1
doc: update COLLABORATOR_GUIDE.md
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-05-12 14:56:34 +01:00
Refael Ackermann
aa3eab00da
doc: fix formatting of TOC
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-30 11:50:09 +01:00
Michael Dawson
1159a717fc doc: add suggestion to use --3way
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-21 11:47:48 -04:00
Rich Trott
1e7f6b1571 doc: run tests before landing changes
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-18 10:19:40 -07:00
Rich Trott
296f33101b doc: avoid colloquialism
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-18 10:12:52 -07:00
Anna Henningsen
42d0f8bf27 doc: s/origin/upstream/ collaborator guide
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-17 14:29:33 -07:00
Evan Lucas
ece9ab5506
doc: add guide for backporting prs
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-04-16 15:39:37 +02:00
Anna Henningsen
0101d77a22
doc: typographical fixes in COLLABORATOR_GUIDE.md
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-04 11:21:03 +01:00
James M Snell
e5bd880a20 meta: add explicit deprecation and semver-major policy
* 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-02-01 11:02:09 -08:00
Evan Lucas
f1253e8627 doc: update LTS info for current releases
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-10 12:32:26 -06:00
Gibson Fahnestock
59a3f868a9 doc: document use of Refs: for references
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>
2017-01-09 23:25:58 -08:00
Emanuel Buholzer
51d8fd3d4e
doc: fix broken link in COLLABORATOR_GUIDE.md
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-21 08:32:32 -05:00
Michael Dawson
9de2adc04d
doc: fix broken link in COLLABORATOR_GUIDE.md
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-16 21:58:45 +01:00
BethGriggs
8951d3e0e5 doc: remove repeated info onboarding.md
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-12-06 09:41:45 -08:00
Rich Trott
add885416f doc: add ctc-review label information
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-19 08:35:15 -07:00
jessicaquynh
98934d29fa doc: explains why Reviewed-By is added in PRs
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-10-13 21:23:51 -04:00
Rich Trott
e3e3588e0e meta: clarify process for breaking changes
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-08-04 22:58:27 -07:00
Wyatt Preul
4c4d9aeff1 collaborator_guide: clarify commit message rules
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-03-13 12:04:58 -05:00
Alexis Campailla
18abb3ccc2 doc: update repo docs to use 'CTC'
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>
2016-02-22 15:09:59 +01:00
James M Snell
dac387e8aa doc: update lts description in the collaborator guide
PR-URL: https://github.com/nodejs/node/pull/3668
Reviewed-By: Julien Gilli <jgilli@fastmail.fm>
2015-11-11 11:51:58 -08:00
Myles Borins
d394e9e6bb doc: add LTS info to COLLABORATOR_GUIDE.md
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-10-28 08:53:27 -07:00
Michał Gołębiowski
02448c69de doc: jenkins-iojs.nodesource.com -> ci.nodejs.org
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-09-24 00:20:53 +02:00
cjihrig
a69ab27ab4 node: rename from io.js to node
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-08-23 17:59:43 -04:00
Rich Trott
0cf94e6856 doc: mention CI in Collaborator Guide
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-17 21:29:23 -07:00
Rich Trott
7a3006efe4 doc: add TOC links to Collaborator Guide
PR-URL: https://github.com/nodejs/io.js/pull/1994
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2015-06-17 14:45:33 -07:00
Rich Trott
74fdf732d0 doc: copyedit COLLABORATOR_GUIDE.md
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-06-14 07:46:28 -07:00
Frederic Hemberger
066274794c doc: update links from iojs/io.js to nodejs/io.js
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-05-18 08:13:09 +02:00
Roman Reiss
bb254b533b doc: update branch to master
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-23 17:41:24 +02:00
Johan Bergström
76f219c128 doc: Document forced pushing with git
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-16 10:09:10 +10:00
Roman Reiss
b464d467a2 doc: update curl usage in COLLABORATOR_GUIDE
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-09 11:47:55 +02:00
Kelsey
d8578bad25 doc: fix minor typos in COLLABORATOR_GUIDE.md
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-04-04 14:47:26 -04:00
Rod Vagg
c52e43d97c doc: clarified & split up contribution docs
- 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.
2015-01-12 22:24:33 +11:00