-
Notifications
You must be signed in to change notification settings - Fork 28.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
Make docs more welcoming and descriptive for newcomers #38056
Changes from 5 commits
f2a5930
2ddd64c
8e056fa
4d5b4e3
cc689c9
91e53d8
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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. | ||
Comment on lines
+3
to
+9
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
||
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. | ||
Comment on lines
+11
to
+15
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
||
## 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) | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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,30 @@ 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: | ||
|
||
* Commits | ||
* Pull requests | ||
* Comments | ||
* Reviews | ||
aduh95 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* Helping others | ||
aduh95 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* Issues | ||
aduh95 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* Participation in other projects, teams, and working groups of the Node.js | ||
organization | ||
aduh95 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* Other participation in the wider Node.js community | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this might be slightly outdated now that we also have a triager role. Contributors who primarily help others, triage issues, comment on PRs and issues, participate in some teams, etc., do not benefit from the commit bit, nor does the project improve their ability to contribute by making them a collaborator in that case.
aduh95 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### 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. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ref: #26287 (comment)