summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
Commit message (Collapse)AuthorAgeFilesLines
* doc: improve documentation for commit subject lineLuigi Pinca2016-10-111-3/+7
| | | | | | | | | | | | | 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>
* doc: remove "feature branch" jargonRich Trott2016-08-241-5/+5
| | | | | | | | | | | | | | | | | | 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>
* doc: *.md formatting fixes in the top-level dirСковорода Никита Андреевич2016-08-101-2/+2
| | | | | | | | | | | | | | | Continuing what a58b48bc3bcf43f7090d4cc914606af68fe55815 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>
* doc: remove platform assumption from CONTRIBUTINGBethany N Griggs2016-08-101-3/+15
| | | | | | | | | | - 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>
* doc: added information on how to run the linter.Diosney Sarmiento2016-07-151-0/+3
| | | | | | | | | | 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>
* doc: specify how to link issues in commit logLuigi Pinca2016-06-151-0/+6
| | | | | | | | 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>
* doc,test: add `How to write a Node.js test` guideSantiago Gimeno2016-06-021-2/+3
| | | | | | | 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>
* doc: fix a typo in the CONTRIBUTING.mdvsemozhetbyt2016-04-261-1/+1
| | | | | | | | | 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>
* doc: git mv to .mdRobert Jefe Lindstaedt2016-04-261-1/+1
| | | | | | | | | | | | | * 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>
* doc: DCO anchor that doesn't changeWilliam Kapke2016-04-261-0/+1
| | | | | | | 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>
* doc: replace node-forward link in CONTRIBUTING.mdBen Noordhuis2016-02-151-1/+1
| | | | | | | | | | 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>
* doc: update DCO to v1.1Mikeal Rogers2016-02-121-10/+19
| | | | | | | | 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>
* doc: update irc channels: #node.js and #node-devNelson Pecora2015-12-141-2/+4
| | | | | | | | 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>
* docs: improve discoverability of Code of ConductAshley Williams2015-11-121-38/+6
| | | | | | | | | | | | | - 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>
* doc: add final full stop in CONTRIBUTING.mdEmily Aviva Kapor-Mater2015-10-301-14/+14
| | | | | | | | | 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>
* doc: add help repo link to CONTRIBUTING.mdDoug Shamoo2015-10-071-0/+3
| | | | | | | | | | | 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>
* doc: use US English for consistencyAnne-Gaelle Colom2015-09-101-2/+2
| | | | | | | | | 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>
* node: rename from io.js to nodecjihrig2015-08-231-13/+13
| | | | | | | | | | | 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>
* doc: recompile before testing core module changesPhillip Johnsen2015-07-191-2/+4
| | | | | | | | | | | | | | | 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>
* doc: fix typo in CONTRIBUTING.mdRich Trott2015-05-221-2/+2
| | | | | | | 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>
* doc: update links from iojs/io.js to nodejs/io.jsFrederic Hemberger2015-05-181-4/+4
| | | | | | | 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>
* doc: update CONTRIBUTING.mdBrendan Ashworth2015-04-181-15/+7
| | | | | | | | | | 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>
* doc: update CONTRIBUTING links.Andrew Crites2015-04-091-2/+2
| | | | | | | | * 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>
* Revert "doc: clarify real name requirement"Jeremiah Senkpiel2015-03-261-3/+3
| | | | | | | | This reverts commit 4e9bf93e9c645f33446f7d47005868ffcb3d281e. PR-URL: https://github.com/iojs/io.js/pull/1276 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Rod Vagg <rod@vagg.org>
* doc: clarify real name requirementRoman Reiss2015-03-241-3/+3
| | | | | | | | 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
* doc: update test section in CONTRIBUTING.mdBen Noordhuis2015-03-171-3/+3
| | | | | | | | 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>
* doc: remove Caine section from contributing guideMichaël Zasso2015-02-111-52/+0
| | | | | | | | | 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>
* First draft of a new contribution policy.Mikeal Rogers2015-01-131-0/+55
| | | | | | | | 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)
* doc: clarified & split up contribution docsRod Vagg2015-01-121-317/+56
| | | | | | | | | | | | | | | | | - 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.
* docs: fix project nameTyler Kellen2014-12-091-4/+4
| | | | | | | 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>
* contributing: add all core modules to Caine's specFedor Indutny2014-12-081-2/+4
| | | | Reviewed-By: Fedor Indutny <fedor@indutny.com>
* contributing: add information for caine botFedor Indutny2014-12-081-0/+49
| | | | | Reviewed-By: Rod Vagg <r@va.gg> PR-URL: https://github.com/iojs/io.js/pull/107
* contributing: commiter git FAQFedor Indutny2014-12-041-3/+107
| | | | | | | | 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
* policy: added contribution policyRod Vagg2014-12-041-0/+160
| | | | | | | | | | 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>
* docs: Change contributing documentation to io.jsTom Gallacher2014-12-021-5/+5
| | | | | Reviewed-By: Fedor Indutny <fedor@indutny.com> PR-URL: https://github.com/iojs/io.js/pull/25
* docs: add issue contributing sectionMax Ogden2014-12-021-0/+13
| | | | | Reviewed-By: Fedor Indutny <fedor@indutny.com> PR-URL: https://github.com/iojs/io.js/pull/21
* docs: highlight shell-codes in CONTRIBUTING.mdIonică Bizău2014-07-011-6/+6
| | | | Signed-off-by: Fedor Indutny <fedor@indutny.com>
* Merge remote-tracking branch 'upstream/v0.10'Timothy J Fontaine2014-06-111-6/+0
|\
| * node: signing the CLA is no longer a requirementTimothy J Fontaine2014-06-111-6/+0
| |
* | docs: Update docs on TEST single test run.Mark Stosberg2014-05-161-0/+13
|/ | | | | | The Contributing docs now clarify how to run a single test. Signed-off-by: Fedor Indutny <fedor@indutny.com>
* doc: clarify subsystems in CONTRIBUTING.mdBen Noordhuis2013-05-141-1/+2
|
* doc: update CONTRIBUTING.mdBen Noordhuis2013-03-241-5/+6
| | | | | * Latest stable is v0.10 now. * Add example of what the first line of the commit log should look like.
* doc: add tools/ dir to CONTRIBUTING.md verboten listBen Noordhuis2013-02-141-4/+4
|
* doc: add CONTRIBUTING.mdBen Noordhuis2012-12-311-0/+145