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

56 Commits

Author SHA1 Message Date
Rich Trott
51cea054a2 doc: remove Locked from stability index
The stability index 3 (Locked) is unused and is being eliminated. Remove
it from the documentation about the stability index.

Remove mention of the Locked from CONTRIBUTING.md. The remaining text
about the stability index is slight and not seemingly valuable. Removing
it too.

PR-URL: https://github.com/nodejs/node/pull/11661
Ref: https://github.com/nodejs/node/issues/11200
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2017-03-05 19:43:05 -08:00
Gibson Fahnestock
ca5215ebe3 doc: add STYLE_GUIDE (moved from nodejs/docs)
Also add a reference in CONTRIBUTING.md to it.

PR-URL: https://github.com/nodejs/node/pull/11321
Reviewed-By: James M Snell <jasnell@gmail.com>
2017-02-16 14:55:54 -08:00
Rich Trott
dccd97dd57 doc: fix linting command for vcbuild
Currently, `vcbuild` only supports `jslint`. `vcbuild lint` will not
work because there is no `lint` task specified in `vcbuild.bat`. Update
documentation to use `vcbuild jslint` instead.

PR-URL: https://github.com/nodejs/node/pull/11151
Reviewed-By: Nikolai Vavilov <vvnicholas@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2017-02-06 15:35:04 -08:00
Rich Trott
251df16aa4 doc: edit CONTRIBUTING.md for clarity
PR-URL: https://github.com/nodejs/node/pull/11045
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Michal Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2017-01-30 08:34:56 -08:00
Gibson Fahnestock
93c4820458 Revert "doc: correct vcbuild options for windows testing"
This reverts commit ed9b6c1264.

PR-URL: https://github.com/nodejs/node/pull/10839
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Evan Lucas <evanlucas@me.com>
2017-01-21 12:00:54 +00:00
Jonathan Boarman
ed9b6c1264 doc: correct vcbuild options for windows testing
Corrected parameter for running tests on Windows. Without the corrected
parameters, Windows users encounter an error about failing to sign the
build, "Failed to sign exe", which can be discouraging to new Windows
community members.

PR-URL: https://github.com/nodejs/node/pull/10686
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
2017-01-10 10:11:24 -08: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
sarahmeyer
c732bd1d93 doc: update CONTRIBUTING.MD with link to V8 guide
Currently, two of the guides in the `/doc/guides` directory are actually
guides for working on the Nodei.js project. Of those, one is linked from
this page. This change adds a note to point people to the other.

PR-URL: https://github.com/nodejs/node/pull/10070
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
2016-12-24 15:47:38 -08:00
Joyee Cheung
44b38bb001 doc: clarify the review and landing process
Adds/mentions:
- Link to glossary
- Commit squashing and CI run
- 48/72 hour wait and PR review feature
- Extra notes section
- "Landed in <sha>" comment

PR-URL: https://github.com/nodejs/node/pull/10202
Ref: https://github.com/nodejs/node/pull/10151
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
2016-12-22 15:54:53 +00:00
Jonathan Darling
0cd1f54fab doc: standardizing on make -j4
Standardizes docs to use -j4 instead of -j8 as it appears to be the
most inclusive recommendation based on discussion in
https://github.com/nodejs/node/pull/9961.

PR-URL: https://github.com/nodejs/node/pull/9961
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
2016-12-09 15:53:20 -05:00
Safia Abdalla
947baaf5b7 doc: rename writing_tests.md to writing-tests.md
The writing_tests.md file did not utilize kebab-case as the other files
in the directory did.

PR-URL: https://github.com/nodejs/node/pull/9867
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
2016-12-03 10:45:27 +01:00
Gibson Fahnestock
7c383bcfa4 doc: update CONTRIBUTING.md to address editing PRs
Add more info about the contribution process after PR submission.

PR-URL: https://github.com/nodejs/node/pull/9259

Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2016-10-28 10:57:33 +01:00
Luigi Pinca
a4d396d858 doc: improve documentation for commit subject line
Specify that commit subject line must be made of only lowercase words
and should start with an imperative verb.

PR-URL: https://github.com/nodejs/node/pull/8546
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2016-09-29 08:34:18 +02:00
Rich Trott
d6d3229603 doc: remove "feature branch" jargon
In the context of the CONTRIBUTING.md document, there is no advantage to
describing the branch as a "feature branch" and the term may be
confusing. Just refer to it as a branch.

Context for the curious: The phrase "feature branch" in CONTIRUBTING.md
confused someone I was assisting today. It occured to me that the word
"feature" doesn't add anything and can be confusing. ("I'm doing a bug
fix so I don't need to create a feature branch, right?")

PR-URL: https://github.com/nodejs/node/pull/8194
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-08-22 14:12:25 -07:00
Сковорода Никита Андреевич
4aa8120aea doc: *.md formatting fixes in the top-level dir
Continuing what a58b48bc3b did for the
doc/ dir, this fixes some formatting issues in the *.md files that
are placed directly in the top-level directory.

README.md changes are excluded as they are covered by
https://github.com/nodejs/node/pull/7971

Refs: https://github.com/nodejs/node/pull/7637
PR-URL: https://github.com/nodejs/node/pull/7727
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-08-04 11:11:37 +03:00
Bethany N Griggs
868638b903
doc: remove platform assumption from CONTRIBUTING
- Specify that the ‘make test’ commands are Unix/OS X specific.
- Link to BUILDING.md for other platform commands.

Fixes: https://github.com/nodejs/node/issues/7646
PR-URL: https://github.com/nodejs/node/pull/7783
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
2016-07-27 23:35:59 +02:00
Diosney Sarmiento
fa46e503b5
doc: added information on how to run the linter.
Added clarification about the linter execution.

PR-URL: https://github.com/nodejs/node/pull/7534
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2016-07-10 22:16:37 +02:00
Luigi Pinca
8a53bd464e doc: specify how to link issues in commit log
PR-URL: https://github.com/nodejs/node/pull/7161
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-06-06 08:59:46 -07:00
Santiago Gimeno
b83b363839 doc,test: add How to write a Node.js test guide
PR-URL: https://github.com/nodejs/node/pull/6984
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Yorkie Liu <yorkiefixer@gmail.com>
2016-05-30 10:24:10 +02:00
vsemozhetbyt
f6d90a912b doc: fix a typo in the CONTRIBUTING.md
Delete a typo dot in the link to stability index.

PR-URL: https://github.com/nodejs/node/pull/6343
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com>
2016-04-22 08:35:39 -07:00
Robert Jefe Lindstaedt
0800c0aa72 doc: git mv to .md
* doc: rename .markdown references in content
* doc: rename to .md in tools
* doc: rename to .md in CONTRIBUTING.md

PR-URL: https://github.com/nodejs/node/pull/4747
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: techjeffharris
Reviewed-By: Johan Bergström <bugs@bergstroem.nu>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
2016-04-20 16:34:27 -07:00
William Kapke
71801b773a doc: DCO anchor that doesn't change
PR-URL: https://github.com/nodejs/node/pull/6257
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-04-18 16:23:35 -07:00
Ben Noordhuis
76b169c88b doc: replace node-forward link in CONTRIBUTING.md
Direct high-level discussion and questions about IP and trademark policy
to the TSC repository.

PR-URL: https://github.com/nodejs/node/pull/5227
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Johan Bergström <bugs@bergstroem.nu>
Reviewed-By: Rod Vagg <r@va.gg>
2016-02-15 08:51:16 +01:00
Mikeal Rogers
d78e6796e0 doc: update DCO to v1.1
PR-URL: https://github.com/nodejs/node/pull/5170
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
2016-02-12 14:18:00 +11:00
Nelson Pecora
3b3061365a doc: update irc channels: #node.js and #node-dev
IRC (general questions): irc.freenode.net #node.js
IRC (node core development): irc.freenode.net #node-dev

PR-URL: https://github.com/nodejs/node/pull/2743
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2015-12-14 19:14:20 -05:00
Ashley Williams
d781cdc349 docs: improve discoverability of Code of Conduct
- move CoC from CONTRIBUTING to top-level, separate COC file
- add note/link in CONTRIBUTING
- add note/link in README (both at top, and newcomer resources)
- move CoC section in CONTRIBUTING to top of file

PR-URL: https://github.com/nodejs/node/pull/3774
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2015-11-12 11:22:16 -08:00
Emily Aviva Kapor-Mater
b7cc19c8f5 doc: add final full stop in CONTRIBUTING.md
PR-URL: https://github.com/nodejs/node/pull/3576
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
2015-10-30 18:09:11 -07:00
Doug Shamoo
35cdded744 doc: add help repo link to CONTRIBUTING.md
Direct help requests and technical issues that are not issues with
Node.js to the nodejs help repo issue tracker. Add link.

PR-URL: https://github.com/nodejs/node/pull/3233
Fixes: https://github.com/nodejs/node/issues/3185
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2015-10-07 22:01:00 -07:00
Anne-Gaelle Colom
e1fb0e8289 doc: use US English for consistency
behaviour -> behavior

PR-URL: https://github.com/nodejs/node/pull/2784
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Brendan Ashworth <brendan.ashworth@me.com>
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
2015-09-10 14:39:16 -07: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
Phillip Johnsen
c7d8b09162 doc: recompile before testing core module changes
Changes to core modules do not take effect unless recompiled. Tip new
contributors about this when describing how to run tests in
contribution guide.

Removed `jslint` from first test command example, as jslint is included
when running `make test`.

Fixed wrong path of example stream2-transform test.

PR-URL: https://github.com/nodejs/io.js/pull/2051
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
2015-07-19 17:00:15 +00:00
Rich Trott
2bb2f06b3e doc: fix typo in CONTRIBUTING.md
PR-URL: https://github.com/nodejs/io.js/pull/1755
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2015-05-22 11:05:51 -04: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
Brendan Ashworth
68707648fd doc: update CONTRIBUTING.md
This commit:
  - fixes development branch (v1.x -> master)
  - updates stability index wording
  - use iojs binary instead of node

PR-URL: https://github.com/iojs/io.js/pull/1466
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2015-04-18 13:13:57 -07:00
Andrew Crites
61c0e7b70f doc: update CONTRIBUTING links.
* Correct link to current collaborator list
* Correct link to Rust CoC

PR-URL: https://github.com/iojs/io.js/pull/1380
Reviewed-By: Roman Reiss <me@silverwind.io>
2015-04-09 11:33:28 +02:00
Jeremiah Senkpiel
5e609e9324 Revert "doc: clarify real name requirement"
This reverts commit 4e9bf93e9c.

PR-URL: https://github.com/iojs/io.js/pull/1276
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Rod Vagg <rod@vagg.org>
2015-03-26 17:50:45 -04:00
Roman Reiss
4e9bf93e9c doc: clarify real name requirement
CONTRIBUTING.md didn't make our rule for requiring real names from
contributors clear enough. This commit shall clarify that part.

Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
PR-URL: https://github.com/iojs/io.js/pull/1250
2015-03-24 23:47:43 +01:00
Ben Noordhuis
69350baaef doc: update test section in CONTRIBUTING.md
test/simple no longer exists, tell contributors to add their tests to
test/parallel.

PR-URL: https://github.com/iojs/io.js/pull/1181
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2015-03-17 21:31:53 +01:00
Michaël Zasso
e80f803298 doc: remove Caine section from contributing guide
Caine bot is not active on the repository anymore.
This section is just confusing for new contributors.

Fixes: https://github.com/iojs/io.js/issues/802
PR-URL: https://github.com/iojs/io.js/pull/804
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2015-02-11 17:02:10 +01:00
Mikeal Rogers
d18829772b First draft of a new contribution policy.
PR-URL: https://github.com/node-forward/node/pull/1
Signed-off-by: isaacs <i@izs.me>

PR-URL: https://github.com/iojs/io.js/pull/348/files
Signed-off-by: isaacs <i@izs.me> (again)
2015-01-13 17:21:04 -08: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
Tyler Kellen
6c36d197bb docs: fix project name
Renamed node.js to io.js and updated links to external resources.

PR-URL: https://github.com/iojs/io.js/pull/42
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2014-12-09 16:18:50 +01:00
Fedor Indutny
e3aa802b38 contributing: add all core modules to Caine's spec
Reviewed-By: Fedor Indutny <fedor@indutny.com>
2014-12-08 18:02:41 +03:00
Fedor Indutny
823cd54c8c contributing: add information for caine bot
Reviewed-By: Rod Vagg <r@va.gg>
PR-URL: https://github.com/iojs/io.js/pull/107
2014-12-08 06:32:14 +03:00
Fedor Indutny
dca1ee4b11 contributing: commiter git FAQ
Describe in details how our current git flow works and could be used.

Fix iojs/io.js#67
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
PR-URL: https://github.com/iojs/io.js/pull/68
2014-12-04 18:06:52 +03:00
Rod Vagg
185d11c791 policy: added contribution policy
Policy originally by @isaacs and @othiym23, submitted by @mikeal,
committed fresh by @rvagg because .. #22 is kind of a mess

PR-URL: https://github.com/iojs/io.js/pull/22
Reviewed-By: Mikeal Rogers <mikeal.rogers@gmail.com>
Reviewed-By: Fedor Indutny <fedor@indutny.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
2014-12-04 21:20:28 +11:00
Tom Gallacher
d24b7b8500 docs: Change contributing documentation to io.js
Reviewed-By: Fedor Indutny <fedor@indutny.com>
PR-URL: https://github.com/iojs/io.js/pull/25
2014-12-02 20:48:14 +03:00
Max Ogden
a647c39acf docs: add issue contributing section
Reviewed-By: Fedor Indutny <fedor@indutny.com>
PR-URL: https://github.com/iojs/io.js/pull/21
2014-12-02 04:58:00 +03:00
Ionică Bizău
02b8109c14 docs: highlight shell-codes in CONTRIBUTING.md
Signed-off-by: Fedor Indutny <fedor@indutny.com>
2014-07-01 16:28:50 +04:00
Timothy J Fontaine
61770f2125 Merge remote-tracking branch 'upstream/v0.10' 2014-06-11 11:59:55 -04:00