Skip to content

Commit

Permalink
doc: make docs more welcoming and descriptive for newcomers
Browse files Browse the repository at this point in the history
Fixes: #26287
PR-URL: #38056
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
  • Loading branch information
srknzl authored and marco-ippolito committed Jun 17, 2024
1 parent 8f8fb91 commit 91fadac
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 3 deletions.
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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)
Expand Down
24 changes: 21 additions & 3 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 91fadac

Please sign in to comment.