Skip to content

Commit bc39796

Browse files
authored
doc: make docs more welcoming and descriptive for newcomers
Fixes: nodejs#26287 PR-URL: nodejs#38056 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]>
1 parent c7e4209 commit bc39796

File tree

2 files changed

+40
-3
lines changed

2 files changed

+40
-3
lines changed

CONTRIBUTING.md

+19
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
# Contributing to Node.js
22

3+
Contributions to Node.js include code, documentation, answering user questions,
4+
running the project's infrastructure, and advocating for all types of Node.js
5+
users.
6+
7+
The Node.js project welcomes all contributions from anyone willing to work in
8+
good faith with other contributors and the community. No contribution is too
9+
small and all contributions are valued.
10+
11+
The Node.js project has an open governance model.
12+
Individuals making significant and valuable contributions are made
13+
Collaborators and given commit-access to the project. See the
14+
[GOVERNANCE.md](./GOVERNANCE.md) document for more information about how this
15+
works.
16+
17+
## Contents
18+
319
* [Code of Conduct](#code-of-conduct)
420
* [Issues](#issues)
521
* [Pull Requests](#pull-requests)
@@ -22,6 +38,9 @@ See [details on our policy on Code of Conduct](./doc/contributing/code-of-conduc
2238

2339
## [Pull Requests](./doc/contributing/pull-requests.md)
2440

41+
Pull Requests are the way concrete changes are made to the code, documentation,
42+
dependencies, and tools contained in the `nodejs/node` repository.
43+
2544
* [Dependencies](./doc/contributing/pull-requests.md#dependencies)
2645
* [Setting up your local environment](./doc/contributing/pull-requests.md#setting-up-your-local-environment)
2746
* [The Process of Making Changes](./doc/contributing/pull-requests.md#the-process-of-making-changes)

GOVERNANCE.md

+21-3
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
* [Technical steering committee](#technical-steering-committee)
99
* [TSC meetings](#tsc-meetings)
1010
* [Collaborator nominations](#collaborator-nominations)
11+
* [Who can nominate Collaborators?](#who-can-nominate-collaborators)
12+
* [Ideal Nominees](#ideal-nominees)
13+
* [Nominating a new Collaborator](#nominating-a-new-collaborator)
1114
* [Onboarding](#onboarding)
1215
* [Consensus seeking process](#consensus-seeking-process)
1316

@@ -124,11 +127,26 @@ the issue tracker is:
124127

125128
## Collaborator nominations
126129

127-
Existing collaborators can nominate someone to become a collaborator. Nominees
128-
should have significant and valuable contributions across the Node.js
130+
### Who can nominate Collaborators?
131+
132+
Existing Collaborators can nominate someone to become a Collaborator.
133+
134+
### Ideal Nominees
135+
136+
Nominees should have significant and valuable contributions across the Node.js
129137
organization.
130138

131-
To nominate a new collaborator, open an issue in the [nodejs/node][] repository.
139+
Contributions can be:
140+
141+
* Opening pull requests.
142+
* Comments and reviews.
143+
* Opening new issues.
144+
* Participation in other projects, teams, and working groups of the Node.js
145+
organization.
146+
147+
### Nominating a new Collaborator
148+
149+
To nominate a new Collaborator, open an issue in the [nodejs/node][] repository.
132150
Provide a summary of the nominee's contributions. For example:
133151

134152
* Commits in the [nodejs/node][] repository.

0 commit comments

Comments
 (0)