From f2a593039fefb6d5191b1ae7d33080bedf6ddc00 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Serkan=20=C3=96zel?= Date: Sat, 3 Apr 2021 13:03:10 +0300 Subject: [PATCH 1/5] doc: make docs more welcoming and descriptive for newcomers Fixes: https://github.com/nodejs/node/issues/26287 --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ GOVERNANCE.md | 26 ++++++++++++++++++++++++-- 2 files changed, 46 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 30db8cf9b12524..0e16b95bce7b54 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,21 @@ # Contributing to Node.js +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 + * [Code of Conduct](#code-of-conduct) * [Issues](#issues) * [Pull Requests](#pull-requests) @@ -15,6 +31,9 @@ See [details on our policy on Code of Conduct](./doc/guides/contributing/code-of ## [Issues](./doc/guides/contributing/issues.md) +Issues in `nodejs/node` are the primary means by which bug reports and +general discussions are made. + * [Asking for General Help](./doc/guides/contributing/issues.md#asking-for-general-help) * [Discussing non-technical topics](./doc/guides/contributing/issues.md#discussing-non-technical-topics) * [Submitting a Bug Report](./doc/guides/contributing/issues.md#submitting-a-bug-report) @@ -22,6 +41,9 @@ See [details on our policy on Code of Conduct](./doc/guides/contributing/code-of ## [Pull Requests](./doc/guides/contributing/pull-requests.md) +Pull Requests are the way concrete changes are made to the code, documentation, +dependencies, and tools contained in the `nodejs/node` repository. + * [Dependencies](./doc/guides/contributing/pull-requests.md#dependencies) * [Setting up your local environment](./doc/guides/contributing/pull-requests.md#setting-up-your-local-environment) * [The Process of Making Changes](./doc/guides/contributing/pull-requests.md#the-process-of-making-changes) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 6ff4d1f5a28ecd..e80c83b710a71e 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -8,6 +8,9 @@ * [Technical steering committee](#technical-steering-committee) * [TSC meetings](#tsc-meetings) * [Collaborator nominations](#collaborator-nominations) + * [Who can nominate Collaborators ?](#who-can-nominate-collaborators-?) + * [Ideal Nominees](#ideal-nominees) + * [Nominating a new Collaborator](#nominating-a-new-collaborator) * [Onboarding](#onboarding) * [Consensus seeking process](#consensus-seeking-process) @@ -120,10 +123,29 @@ the issue tracker is: ## Collaborator nominations -Existing Collaborators can nominate someone to become a Collaborator. Nominees -should have significant and valuable contributions across the Node.js +### Who can nominate Collaborators ? + +Existing Collaborators can nominate someone to become a Collaborator. + +### Ideal Nominees + +Nominees should have significant and valuable contributions across the Node.js organization. +Contributions can be: + +* Commits +* Pull requests +* Comments +* Reviews +* Helping others +* Issues +* Participation in other projects, teams, and working groups of the Node.js +organization +* Other participation in the wider Node.js community + +### Nominating a new Collaborator + To nominate a new Collaborator, open an issue in the [nodejs/node][] repository. Provide a summary of the nominee's contributions. For example: From 2ddd64c7e4218fd7a147a1ff1a97ed63bfe0c9ea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Serkan=20=C3=96zel?= Date: Sat, 3 Apr 2021 13:27:27 +0300 Subject: [PATCH 2/5] doc: delete trailing space in header --- GOVERNANCE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index e80c83b710a71e..2cd8ddede958d6 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -8,7 +8,7 @@ * [Technical steering committee](#technical-steering-committee) * [TSC meetings](#tsc-meetings) * [Collaborator nominations](#collaborator-nominations) - * [Who can nominate Collaborators ?](#who-can-nominate-collaborators-?) + * [Who can nominate Collaborators?](#who-can-nominate-collaborators?) * [Ideal Nominees](#ideal-nominees) * [Nominating a new Collaborator](#nominating-a-new-collaborator) * [Onboarding](#onboarding) @@ -123,7 +123,7 @@ the issue tracker is: ## Collaborator nominations -### Who can nominate Collaborators ? +### Who can nominate Collaborators? Existing Collaborators can nominate someone to become a Collaborator. From 8e056fa3318926b7d32e3f67128487548abb59d5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Serkan=20=C3=96zel?= Date: Sat, 3 Apr 2021 13:32:43 +0300 Subject: [PATCH 3/5] doc: fix link in toc --- GOVERNANCE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 2cd8ddede958d6..e46c28c0201471 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -8,7 +8,7 @@ * [Technical steering committee](#technical-steering-committee) * [TSC meetings](#tsc-meetings) * [Collaborator nominations](#collaborator-nominations) - * [Who can nominate Collaborators?](#who-can-nominate-collaborators?) + * [Who can nominate Collaborators?](#who-can-nominate-collaborators) * [Ideal Nominees](#ideal-nominees) * [Nominating a new Collaborator](#nominating-a-new-collaborator) * [Onboarding](#onboarding) From cc689c9d56023847c25a8cb8d9bbf328605e82f4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Serkan=20=C3=96zel?= Date: Sun, 19 Jun 2022 22:46:19 +0300 Subject: [PATCH 4/5] Linting --- GOVERNANCE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index e56c83b5aaedc6..0e01dbf739c14b 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -145,7 +145,7 @@ Contributions can be: * Helping others * Issues * Participation in other projects, teams, and working groups of the Node.js -organization + organization * Other participation in the wider Node.js community ### Nominating a new Collaborator From 91e53d8d21a9e9845c8fe0d933d01e562d7d967d Mon Sep 17 00:00:00 2001 From: Antoine du Hamel Date: Sun, 5 May 2024 23:49:23 +0200 Subject: [PATCH 5/5] Apply suggestions from code review --- GOVERNANCE.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 0e01dbf739c14b..9cdcced84534fe 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -138,15 +138,11 @@ organization. Contributions can be: -* Commits -* Pull requests -* Comments -* Reviews -* Helping others -* Issues +* Opening pull requests. +* Comments and reviews. +* Opening new issues. * Participation in other projects, teams, and working groups of the Node.js - organization -* Other participation in the wider Node.js community + organization. ### Nominating a new Collaborator