summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
AgeCommit message (Collapse)Author
2017-10-02doc: add missing TOC entry in CONTRIBUTING.mdVse Mozhet Byt
PR-URL: https://github.com/nodejs/node/pull/15729 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2017-10-01test: make it easier to run tests for subsystemsBenjamin Coe
You can now run suites for subsystem using shorthand, e.g., http. Switch to black-list of default test folders from white-list. Tests run by 'make test', 'make coverage', etc., now configurable. Stop running known_issues suite when collecting test coverage. PR-URL: https://github.com/nodejs/node/pull/15450 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>
2017-09-13meta: improve contributors guideJames M Snell
PR-URL: https://github.com/nodejs/node/pull/15123 Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>
2017-06-10doc: use HTTPS URL for suggested upstream remoteNikolai Vavilov
It's impossible to push to git:// URLs. PR-URL: https://github.com/nodejs/node/pull/13602 Fixes: https://github.com/nodejs/node/issues/13600 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Brian White <mscdex@mscdex.net>
2017-05-11doc: Change options at STEP 5 in CONTRIBUTING.mdkysnm
PR-URL: https://github.com/nodejs/node/pull/12830 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
2017-05-04doc: edit CONTRIBUTING.md for clarity etc.Rich Trott
PR-URL: https://github.com/nodejs/node/pull/12796 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>
2017-04-22doc: make commit guidelines easier to referenceBenjamin Fleischer
- Can now link to 'Commit Guidelines' from pull requests - Breaks up commit requirements and recommendations PR-URL: https://github.com/nodejs/node/pull/11732 Refs: https://github.com/nodejs/node/pull/11723#issuecomment-284556146 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
2017-04-21doc: update link to Code of ConductAlex Autem
PR-URL: https://github.com/nodejs/node/pull/12552 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
2017-04-17doc: add missing ) in CONTRIBUTING.mdMateusz Konieczny
PR-URL: https://github.com/nodejs/node/pull/12444 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
2017-04-04doc: change Mac OS X to macOSJR McEntee
This update changes references to "Mac OS X", "OS X", and "OSX" in markdown files to "macOS". PR-URL: https://github.com/nodejs/node/pull/12106 Fixes: https://github.com/nodejs/node/issues/12086 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2017-03-17build: add cpp linting to windows buildliusi
This PR adds cpp linting to windows build script. After this change, running command `vcbuild lint` will run both cpp linting and javascript linting on a windows machine. PR-URL: https://github.com/nodejs/node/pull/11856 Fixes: https://github.com/nodejs/node/issues/11816 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2017-03-16doc: linkable commit message guidelinesSam Roberts
Put the commit guidelines themselves under a heading to be more prominent, and to allow linking directly to them (instead of the section on how to use git). Link the pull request template to the guidelines, so contributors can find them. PR-URL: https://github.com/nodejs/node/pull/11792 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>
2017-03-05doc: remove Locked from stability indexRich Trott
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-02-16doc: add STYLE_GUIDE (moved from nodejs/docs)Gibson Fahnestock
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-06doc: fix linting command for vcbuildRich Trott
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-01-30doc: edit CONTRIBUTING.md for clarityRich Trott
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-21Revert "doc: correct vcbuild options for windows testing"Gibson Fahnestock
This reverts commit ed9b6c1264a07084e44f1d269bfe82e0f1b37c74. 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-10doc: correct vcbuild options for windows testingJonathan Boarman
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-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-24doc: update CONTRIBUTING.MD with link to V8 guidesarahmeyer
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-22doc: clarify the review and landing processJoyee Cheung
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-09doc: standardizing on make -j4Jonathan Darling
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-03doc: rename writing_tests.md to writing-tests.mdSafia Abdalla
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-10-28doc: update CONTRIBUTING.md to address editing PRsGibson Fahnestock
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-09-29doc: improve documentation for commit subject lineLuigi Pinca
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-08-22doc: remove "feature branch" jargonRich Trott
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-04doc: *.md formatting fixes in the top-level dirСковорода Никита Андреевич
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>
2016-07-27doc: remove platform assumption from CONTRIBUTINGBethany N Griggs
- 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-10doc: added information on how to run the linter.Diosney Sarmiento
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-06-06doc: specify how to link issues in commit logLuigi Pinca
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-05-30doc,test: add `How to write a Node.js test` guideSantiago Gimeno
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-04-22doc: fix a typo in the CONTRIBUTING.mdvsemozhetbyt
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-20doc: git mv to .mdRobert Jefe Lindstaedt
* 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-18doc: DCO anchor that doesn't changeWilliam Kapke
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-02-15doc: replace node-forward link in CONTRIBUTING.mdBen Noordhuis
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-12doc: update DCO to v1.1Mikeal Rogers
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>
2015-12-14doc: update irc channels: #node.js and #node-devNelson Pecora
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-11-12docs: improve discoverability of Code of ConductAshley Williams
- 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-10-30doc: add final full stop in CONTRIBUTING.mdEmily Aviva Kapor-Mater
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-07doc: add help repo link to CONTRIBUTING.mdDoug Shamoo
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-09-10doc: use US English for consistencyAnne-Gaelle Colom
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-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-07-19doc: recompile before testing core module changesPhillip Johnsen
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-05-22doc: fix typo in CONTRIBUTING.mdRich Trott
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-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-18doc: update CONTRIBUTING.mdBrendan Ashworth
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-09doc: update CONTRIBUTING links.Andrew Crites
* 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-03-26Revert "doc: clarify real name requirement"Jeremiah Senkpiel
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>
2015-03-24doc: clarify real name requirementRoman Reiss
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-17doc: update test section in CONTRIBUTING.mdBen Noordhuis
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>
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-01 09:06:00 +0000