Matteo Collina
553aec1f7f
doc: document open pull request limit
...
Signed-off-by: Matteo Collina <hello@matteocollina.com >
PR-URL: https://github.com/nodejs/node/pull/65250
Reviewed-By: Aviv Keller <me@aviv.sh >
Reviewed-By: René <contact.9a5d6388@renegade334.me.uk >
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com >
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com >
Reviewed-By: Michaël Zasso <targos@protonmail.com >
Reviewed-By: Daeyeon Jeong <daeyeon.dev@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Stewart X Addison <sxa@redhat.com >
Reviewed-By: Mike McCready <66998419+MikeMcC399@users.noreply.github.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Chengzhong Wu <legendecas@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
Reviewed-By: Beth Griggs <bethanyngriggs@gmail.com >
2026-08-14 20:50:00 +00:00
3b214e084c
doc: create ai-guidelines and include to CONTRIBUTING
...
Co-authored-by: Beth Griggs <bethanyngriggs@gmail.com >
Co-authored-by: Aditi <62544124+Aditi-1400@users.noreply.github.com >
Co-authored-by: Joyee Cheung <joyeec9h3@gmail.com >
Co-authored-by: Tobias Nießen <tniessen@tnie.de >
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com >
Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com >
Co-authored-by: Efe <dogukankrskl@gmail.com >
Co-authored-by: James M Snell <jasnell@gmail.com >
Co-authored-by: Trivikram Kamat <16024985+trivikr@users.noreply.github.com >
Signed-off-by: RafaelGSS <rafael.nunu@hotmail.com >
PR-URL: https://github.com/nodejs/node/pull/62105
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com >
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Aditi Singh <aditisingh1400@gmail.com >
Reviewed-By: Gürgün Dayıoğlu <hey@gurgun.day >
Reviewed-By: Moshe Atlow <moshe@atlow.co.il >
Reviewed-By: Robert Nagy <ronagy@icloud.com >
Reviewed-By: Daeyeon Jeong <daeyeon.dev@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com >
Reviewed-By: Paolo Insogna <paolo@cowtech.it >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com >
Reviewed-By: Chengzhong Wu <legendecas@gmail.com >
Reviewed-By: Filip Skokan <panva.ip@gmail.com >
Reviewed-By: Jacob Smith <jacob@frende.me >
Reviewed-By: Claudio Wunder <cwunder@gnome.org >
Reviewed-By: Mike McCready <66998419+MikeMcC399@users.noreply.github.com >
2026-08-12 18:23:46 +00:00
Joyee Cheung
457fa67062
doc: add guide and answers to FAQs for first-time contributors
...
Signed-off-by: Joyee Cheung <joyeec9h3@gmail.com >
PR-URL: https://github.com/nodejs/node/pull/63685
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
Reviewed-By: Moshe Atlow <moshe@atlow.co.il >
Reviewed-By: Filip Skokan <panva.ip@gmail.com >
2026-06-30 13:07:26 +00:00
Matteo Collina
20e6a54b55
doc: add large pull requests contributing guide
...
- Exclude routine dependency/WPT/bot PRs from the policy
- Replace design document requirement with detailed PR description
- Clarify dependency commit ordering for squash landing
- Remove splitting strategies that contradict self-contained PRs
- Add links from CONTRIBUTING.md, pull-requests.md,
collaborator-guide.md
Signed-off-by: Matteo Collina <hello@matteocollina.com >
PR-URL: https://github.com/nodejs/node/pull/62829
Fixes: https://github.com/nodejs/node/issues/62752
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com >
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com >
Reviewed-By: Chengzhong Wu <legendecas@gmail.com >
Reviewed-By: Paolo Insogna <paolo@cowtech.it >
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com >
Reviewed-By: Gürgün Dayıoğlu <hey@gurgun.day >
Reviewed-By: Ruy Adorno <ruy@vlt.sh >
2026-05-11 08:45:18 +00:00
Chengzhong Wu
f67cf472ae
meta: add automation policy
...
PR-URL: https://github.com/nodejs/node/pull/62871
Reviewed-By: Filip Skokan <panva.ip@gmail.com >
Reviewed-By: Richard Lau <richard.lau@ibm.com >
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com >
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com >
Reviewed-By: Michaël Zasso <targos@protonmail.com >
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
Reviewed-By: Chemi Atlow <chemi@atlow.co.il >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com >
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com >
Reviewed-By: Tobias Nießen <tniessen@tnie.de >
Reviewed-By: Ethan Arrowood <ethan@arrowood.dev >
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com >
2026-04-27 05:18:07 +00:00
Aviv Keller
e30928485e
doc, meta: use markdown rather than HTML in CONTRIBUTING.md
...
PR-URL: https://github.com/nodejs/node/pull/53235
Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
2024-06-08 19:16:44 +00:00
Serkan Özel
bc39796b06
doc: make docs more welcoming and descriptive for newcomers
...
Fixes: https://github.com/nodejs/node/issues/26287
PR-URL: https://github.com/nodejs/node/pull/38056
Reviewed-By: Richard Lau <rlau@redhat.com >
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com >
2024-05-06 00:07:10 +02:00
Michael Dawson
a199387f04
doc: make contributing info more discoverable
...
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 >
2022-01-18 14:24:30 -05:00
Rich Trott
86099a375a
tools: avoid unnecessary escaping in markdown formatter
...
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-31 09:36:05 -07:00
Rich Trott
88e82b890b
doc: format general markdown files
...
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-10-06 21:20:55 -07:00
Rich Trott
549f96889a
doc: update markdown formatting for *.md files
...
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-09-21 15:37:19 +00:00
Michael Dawson
7a4c2c8d86
doc: change links to use HEAD in top level docs
...
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-27 12:03:22 -08:00
Akash Negi
b5f5c46129
doc: fix list format in Developer's Certificate of Origin
...
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-02-01 16:19:10 +01:00
Rich Trott
2afbfb0ac2
doc: remove resolving-a-bug-report from contributing docs
...
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-15 21:22:03 -08:00
Rich Trott
9886d5ebf9
doc: remove unnecessary contributing.md section
...
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 >
2021-01-14 09:03:54 -08:00
ConorDavenport
bf7409e974
doc: improve doc/markdown file organization coherence
...
* 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 >
2020-03-04 13:13:07 +00:00
Maledong
872d803faf
doc: remove the suffix number of the anchor link
...
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 >
2019-09-22 13:35:18 -07:00
Rich Trott
7e1b178fb6
doc: streamline CONTRIBUTING.md
...
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-11-05 05:59:49 +01:00
ZYSzys
639ec8314e
doc: add contents table to CONTRIBUTING.md
...
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-10-01 09:16:57 -07:00
Joyee Cheung
695ed671fc
doc: split CONTRIBUTING.md
...
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-24 03:23:40 +08:00
Rich Trott
e6a401e0ae
doc: improve PR-review paragraph in CONTRIBUTING.md
...
* 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-03 13:47:58 -05:00
Rich Trott
5bda05548b
doc: fix typos in CONTRIBUTING.md
...
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 >
2018-01-03 13:46:20 -05:00
Rich Trott
90abfd672f
doc: edit CONTRIBUTING.md preamble
...
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-18 13:23:39 -08:00
Rich Trott
ff9a6bc1f3
doc: add missing serial commas
...
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-12-01 14:46:36 -08:00
Myles Borins
645cd19b58
doc: move Code of Conduct to admin repo
...
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-28 10:45:24 +09:00
Ronald Eddy Jr
de3bb8f843
doc: update http URLs to https in CONTRIBUTING.md
...
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-23 16:01:48 -05:00
Maton Anthony
2dcdd1d152
doc: outline commit message for breaking changes
...
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-11-11 11:55:53 +01:00
James M Snell
1cdcab09f2
doc: slightly relax 50 character rule
...
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-29 10:07:16 -07:00
Daijiro Wachi
986be03a4c
doc: fix doc styles
...
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-24 18:04:18 +02:00
Vse Mozhet Byt
6d4c68523d
meta: add note about email sync to CONTRIBUTING.md
...
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-21 15:53:02 +05:30
Anna Henningsen
23340b9234
doc: add basic C++ style guide
...
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-14 11:13:29 +02:00
Vse Mozhet Byt
3f1cca4817
doc: add missing TOC entry in CONTRIBUTING.md
...
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-02 12:43:05 +03:00
Benjamin Coe
5be4dfaa13
test: make it easier to run tests for subsystems
...
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-10-01 20:30:48 -03:00
James M Snell
bf1ca8fb2e
meta: improve contributors guide
...
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-09-13 10:45:50 -07:00
Nikolai Vavilov
24e5b67148
doc: use HTTPS URL for suggested upstream remote
...
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-06-10 22:58:54 +03:00
kysnm
d7d16f7b8b
doc: Change options at STEP 5 in CONTRIBUTING.md
...
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-11 20:40:57 -04:00
Rich Trott
0258aed9d2
doc: edit CONTRIBUTING.md for clarity etc.
...
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-05-04 15:55:38 -07:00
Benjamin Fleischer
bd97e48d9a
doc: make commit guidelines easier to reference
...
- 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-22 18:58:15 +01:00
Alex Autem
8ecb2cadfc
doc: update link to Code of Conduct
...
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-21 02:40:31 +03:00
Mateusz Konieczny
6724f780f9
doc: add missing ) in CONTRIBUTING.md
...
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-17 16:10:02 +02:00
JR McEntee
7a5d07c7fb
doc: change Mac OS X to macOS
...
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-04-04 10:14:24 -07:00
liusi
379eec357d
build: add cpp linting to windows build
...
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-17 09:22:46 -07:00
Sam Roberts
303962aca1
doc: linkable commit message guidelines
...
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-16 15:42:57 -07:00
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