Nodejs/node
1
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2024-11-21 10:59:27 +00:00
Code Issues Actions 25 Packages Projects Releases Wiki Activity
0b020089d9
node/CONTRIBUTING.md

79 lines
3.3 KiB
Markdown
Raw Normal View History

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-13 16:14:34 +00:00
# Contributing to Node.js
doc: add CONTRIBUTING.md
2012-12-30 23:36:47 +00:00
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-05 22:07:10 +00:00
Contributions to Node.js include code, documentation, answering user questions,
running the project's infrastructure, and advocating for all types of Node.js
users.
The Node.js project welcomes all contributions from anyone willing to work in
good faith with other contributors and the community. No contribution is too
small and all contributions are valued.
The Node.js project has an open governance model.
Individuals making significant and valuable contributions are made
Collaborators and given commit-access to the project. See the
[GOVERNANCE.md](./GOVERNANCE.md) document for more information about how this
works.
## Contents
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-09-28 06:40:12 +00:00
* [Code of Conduct](#code-of-conduct)
* [Issues](#issues)
* [Pull Requests](#pull-requests)
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-06 05:42:37 +00:00
* [Developer's Certificate of Origin 1.1](#developers-certificate-of-origin)
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-09-28 06:40:12 +00:00
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-05 18:26:30 +00:00
## [Code of Conduct](./doc/contributing/code-of-conduct.md)
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-08-31 20:06:16 +00:00
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-20 15:19:03 +00:00
The Node.js project has a
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-30 22:40:34 +00:00
[Code of Conduct](https://github.com/nodejs/admin/blob/HEAD/CODE_OF_CONDUCT.md)
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-01 04:57:58 +00:00
to which all contributors must adhere.
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-11 15:33:43 +00:00
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-05 18:26:30 +00:00
See [details on our policy on Code of Conduct](./doc/contributing/code-of-conduct.md).
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-11 15:33:43 +00:00
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-05 18:26:30 +00:00
## [Issues](./doc/contributing/issues.md)
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-08-31 20:06:16 +00:00
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-05 18:26:30 +00:00
* [Asking for General Help](./doc/contributing/issues.md#asking-for-general-help)
* [Discussing non-technical topics](./doc/contributing/issues.md#discussing-non-technical-topics)
* [Submitting a Bug Report](./doc/contributing/issues.md#submitting-a-bug-report)
* [Triaging a Bug Report](./doc/contributing/issues.md#triaging-a-bug-report)
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-02 11:52:50 +00:00
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-05 18:26:30 +00:00
## [Pull Requests](./doc/contributing/pull-requests.md)
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-08-31 20:06:16 +00:00
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-05 22:07:10 +00:00
Pull Requests are the way concrete changes are made to the code, documentation,
dependencies, and tools contained in the `nodejs/node` repository.
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-05 18:26:30 +00:00
* [Dependencies](./doc/contributing/pull-requests.md#dependencies)
* [Setting up your local environment](./doc/contributing/pull-requests.md#setting-up-your-local-environment)
* [The Process of Making Changes](./doc/contributing/pull-requests.md#the-process-of-making-changes)
* [Reviewing Pull Requests](./doc/contributing/pull-requests.md#reviewing-pull-requests)
* [Notes](./doc/contributing/pull-requests.md#notes)
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-08-31 20:06:16 +00:00
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 17:01:51 +00:00
<a id="developers-certificate-of-origin"></a>
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-18 00:23:11 +00:00
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-09 22:07:49 +00:00
## Developer's Certificate of Origin 1.1
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)
2014-10-01 20:40:32 +00:00
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-18 00:23:11 +00:00
<pre>
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)
2014-10-01 20:40:32 +00:00
By making a contribution to this project, I certify that:
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-01-30 05:26:56 +00:00
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
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-18 00:23:11 +00:00
</pre>
Reference in New Issue Copy Permalink