Make docs more welcoming and descriptive for newcomers #38056
Conversation
nodejs-github-bot
added
doc
| 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 |
There was a problem hiding this comment.
ref: #26287 (comment)
| 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. |
There was a problem hiding this comment.
| 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. |
There was a problem hiding this comment.
CONTRIBUTING.md
Outdated
| @@ -15,13 +31,19 @@ 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 | |||
There was a problem hiding this comment.
This if from 7e1b178#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L32
I don't feel strong about this, but I think having a short description is better. Same for pull requests below
There was a problem hiding this comment.
I agree having a description is better.
Maybe if it's worth mentioning https://github.com/nodejs/node/discussions?
There was a problem hiding this comment.
I meant adding a section ## Discussions that introduces what are discussions and how to contribute on them. It can also be done in a follow up PR.
There was a problem hiding this comment.
Maybe we can add a section with this content of this discussion: #35662
also we can give a link to discussions page (https://github.com/nodejs/node/discussions/)
CONTRIBUTING.md
Outdated
| @@ -15,13 +31,19 @@ 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 | |||
There was a problem hiding this comment.
I agree having a description is better.
Maybe if it's worth mentioning https://github.com/nodejs/node/discussions?
GOVERNANCE.md
Outdated
| ### 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 | ||
|
|
There was a problem hiding this comment.
I splitted this part to make it friendly for both collaborators and non-collaborators .
|
is this pull request still relevant? |
I have merged upstream/main into this branch. I think it still is. |
|
Pinging some of the folks who engaged in #26287: @mcollina @richardlau @sxa |
GOVERNANCE.md
Outdated
| ## 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 | ||
| * Helping others | ||
| * Issues | ||
| * Participation in other projects, teams, and working groups of the Node.js | ||
| organization | ||
| * Other participation in the wider Node.js community |
There was a problem hiding this comment.
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
added
the
author ready
Fixes: nodejs#26287 PR-URL: nodejs#38056 Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Fixes: nodejs#26287 PR-URL: nodejs#38056 Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Fixes: nodejs#26287 PR-URL: nodejs#38056 Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Hello 😊 I wanted to try improving quality of docs in perspective of a new contributor.
Fixes: #26287