Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
AgeCommit message (Collapse)Author
2022-01-18doc: make contributing info more discoverableMichael Dawson
There are been several discussions in recent PRs about the docs related to contributing not being very discoverable. Move these docs from doc/guides/ to doc/contributing. Signed-off-by: Michael Dawson <mdawson@devrus.com> PR-URL: https://github.com/nodejs/node/pull/41408 Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is> Reviewed-By: Mary Marchini <oss@mmarchini.me> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-10-31tools: avoid unnecessary escaping in markdown formatterRich Trott
Update mdast-util-to-markdown to 1.2.4 which reduces unnecessary escaping of `_` and some other characters. Re-run markdown formatter. PR-URL: https://github.com/nodejs/node/pull/40645 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>
2021-10-07doc: format general markdown filesRich Trott
Use `make format-md` to format general markdown files. PR-URL: https://github.com/nodejs/node/pull/40322 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Zijian Liu <lxxyxzj@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-09-21doc: update markdown formatting for *.md filesRich Trott
Fix formatting that will change when run through upcoming remark preset. PR-URL: https://github.com/nodejs/node/pull/40154 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com>
2021-02-27doc: change links to use HEAD in top level docsMichael Dawson
Change the top level docs to use HEAD in links Signed-off-by: Michael Dawson <mdawson@devrus.com> PR-URL: https://github.com/nodejs/node/pull/37494 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com>
2021-02-01doc: fix list format in Developer's Certificate of OriginAkash Negi
This corresponds to the format at https://developercertificate.org/. PR-URL: https://github.com/nodejs/node/pull/37138 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Pooja D P <Pooja.D.P@ibm.com> Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
2021-01-16doc: remove resolving-a-bug-report from contributing docsRich Trott
This section isn't particularly useful in this context and contributes to making the document longer and less effective. This is part of a larger effort to make the contributing docs brief, informative, and friendly. Refs: https://github.com/nodejs/TSC/issues/864#issuecomment-628646560 PR-URL: https://github.com/nodejs/node/pull/36905 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2021-01-14doc: remove unnecessary contributing.md sectionRich Trott
Remove "How to Contribute in Issues". This is not Node.js-specific and is likely to cause many readers to tune out. If we want to include this kind of how-all-issue-trackers-are-intended-to-work information, let's link to an external source. But I think it's OK to simply remove it. Refs: https://github.com/nodejs/TSC/issues/864#issuecomment-628646560 PR-URL: https://github.com/nodejs/node/pull/36891 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com>
2020-03-04doc: improve doc/markdown file organization coherenceConorDavenport
* Updated cpp style guide file name and location and fixed links to this file. * Updated collaborator guide file name and location and fixed links to this file. * Updated documentation style guide file name and location and updated links referencing the file. * Moved files to appropriate location and updated naming style for some of them. Fixes: https://github.com/nodejs/node/issues/31741 PR-URL: https://github.com/nodejs/node/pull/31792 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
2019-09-22doc: remove the suffix number of the anchor linkMaledong
Remove the number '11' as the suffix anchor id for the 'Developer's Certificate of Origin 1.1'. PR-URL: https://github.com/nodejs/node/pull/29468 Refs: https://github.com/nodejs/node/pull/6257 Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2018-11-05doc: streamline CONTRIBUTING.mdRich Trott
PR-URL: https://github.com/nodejs/node/pull/24010 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
2018-10-01doc: add contents table to CONTRIBUTING.mdZYSzys
PR-URL: https://github.com/nodejs/node/pull/23140 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2018-01-23doc: split CONTRIBUTING.mdJoyee Cheung
PR-URL: https://github.com/nodejs/node/pull/18271 Fixes: https://github.com/nodejs/node/issues/17842 Reviewed-By: Michaël 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>
2018-01-03doc: improve PR-review paragraph in CONTRIBUTING.mdRich Trott
* Remove redundant "blocking it or stopping it" as blocking and stopping are the same thing in this case. * Make another sentence less wordy. Fix incorrect verb conjugation. Break into two clear sentences. PR-URL: https://github.com/nodejs/node/pull/17931 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
2018-01-03doc: fix typos in CONTRIBUTING.mdRich Trott
Remove incorrect usage of "in which". The sentence is better and shorter without it anyway. Replace incorrect "with" with "in". PR-URL: https://github.com/nodejs/node/pull/17930 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Weijia Wang <starkwang@126.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>
2017-12-19doc: edit CONTRIBUTING.md preambleRich Trott
Make the preamble to CONTRIBUTING.md more concise and focused. PR-URL: https://github.com/nodejs/node/pull/17700 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2017-12-02doc: add missing serial commasRich Trott
PR-URL: https://github.com/nodejs/node/pull/17384 Reviewed-By: Timothy Gu <timothygu99@gmail.com> Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2017-11-28doc: move Code of Conduct to admin repoMyles Borins
The CoC and moderation guidelines now live in the Admin repo. This PR updates the copy of CODE_OF_CONDUCT.md and references in other documents to the proper location. PR-URL: https://github.com/nodejs/node/pull/17301 Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
2017-11-24doc: update http URLs to https in CONTRIBUTING.mdRonald Eddy Jr
PR-URL: https://github.com/nodejs/node/pull/17261 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
2017-11-11doc: outline commit message for breaking changesMaton Anthony
Add informations to CONTRIBUTING.md requesting the committers and especially the one working on breaking changes to write proper commits messages containing the reason behind the breaking changes, the case during which it can be triggered, and a description of the breaking change in itself. PR-URL: https://github.com/nodejs/node/pull/16846 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
2017-10-29doc: slightly relax 50 character ruleJames M Snell
Allow commit message first line to exceed 50 chars if necessary PR-URL: https://github.com/nodejs/node/pull/16523 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
2017-10-24doc: fix doc stylesDaijiro Wachi
CONTRIBUTING.md + L857: Unused definition + L861: Unused definition + L863: Unused definition doc/api/assert.md + L719: Unused definition doc/api/async_hooks.md + L460: Missing code-language flag doc/api/child_process.md + L1362: Unused definition doc/api/dns.md + L674: Unused definition doc/api/esm.md + L178: Missing code-language flag doc/api/http.md + L1868: Unused definition + L1887: Unused definition + L1888: Unused definition + L1889: Unused definition + L1916: Unused definition + L1917: Unused definition doc/api/https.md + L260: Unused definition doc/api/os.md + L1226: Unused definition doc/api/process.md + L1888: Unused definition doc/api/stream.md + L2227: Definitions with the same identifier doc/guides/writing-and-running-benchmarks.md + L1: Missing newline character at end of file Refs: https://github.com/nodejs/node/pull/12756 PR-URL: https://github.com/nodejs/node/pull/16385 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2017-10-21meta: add note about email sync to CONTRIBUTING.mdVse Mozhet Byt
PR-URL: https://github.com/nodejs/node/pull/16340 Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Refs: https://github.com/nodejs/node/pull/16339#issuecomment-338240029
2017-10-14doc: add basic C++ style guideAnna Henningsen
Ideally, most of these things would be enforced via linter rules. This is a first step into having a style guide that goes beyond what the linter currently enforces. PR-URL: https://github.com/nodejs/node/pull/16090 Fixes: https://github.com/nodejs/node/issues/12636 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Timothy Gu <timothygu99@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
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-02test: 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-12doc: 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-05doc: 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-17doc: 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-06doc: 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-17doc: 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-07doc: 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-10doc: 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-25doc: 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-23doc: 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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-08-02 23:41:01 +0300