From bc39796b06d1713a1347807ad60493a19844bfdb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Serkan=20=C3=96zel?= Date: Mon, 6 May 2024 01:07:10 +0300 Subject: [PATCH] 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 Reviewed-By: Antoine du Hamel --- CONTRIBUTING.md | 19 +++++++++++++++++++ GOVERNANCE.md | 24 +++++++++++++++++++++--- 2 files changed, 40 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f815adbb1fc34b..96cddfafb784c8 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) @@ -22,6 +38,9 @@ See [details on our policy on Code of Conduct](./doc/contributing/code-of-conduc ## [Pull Requests](./doc/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/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) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 1a5faf99a480ec..f898396952a7d2 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) @@ -124,11 +127,26 @@ 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. -To nominate a new collaborator, open an issue in the [nodejs/node][] repository. +Contributions can be: + +* Opening pull requests. +* Comments and reviews. +* Opening new issues. +* Participation in other projects, teams, and working groups of the Node.js + organization. + +### 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: * Commits in the [nodejs/node][] repository.