Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Make docs more welcoming and descriptive for newcomers #38056

Merged
merged 6 commits into from May 5, 2024
Merged

Make docs more welcoming and descriptive for newcomers #38056

merged 6 commits into from May 5, 2024

Conversation

srknzl
Copy link
Contributor

@srknzl srknzl commented Apr 3, 2021

Hello 馃槉 I wanted to try improving quality of docs in perspective of a new contributor.

Fixes: #26287

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project. labels Apr 3, 2021
srknzl
srknzl commented Apr 3, 2021
View reviewed changes
CONTRIBUTING.md
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
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ref: #26287 (comment)

srknzl
srknzl commented Apr 3, 2021
View reviewed changes
CONTRIBUTING.md
Comment on lines +3 to +9
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.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part is from 7e1b178#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L3

srknzl
srknzl commented Apr 3, 2021
View reviewed changes
CONTRIBUTING.md
Comment on lines +11 to +15
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.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is from https://github.com/nodejs/node/pull/12796/files#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L25

srknzl
srknzl commented Apr 3, 2021
View reviewed changes
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
Copy link
Contributor Author

@srknzl srknzl Apr 3, 2021 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree having a description is better.
Maybe if it's worth mentioning https://github.com/nodejs/node/discussions?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#38057

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

@srknzl srknzl Apr 3, 2021 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/)

aduh95
aduh95 reviewed Apr 3, 2021
View reviewed changes
Copy link
Contributor

@aduh95 aduh95 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this :)

GOVERNANCE.md Outdated Show resolved Hide resolved
GOVERNANCE.md Outdated Show resolved Hide resolved
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree having a description is better.
Maybe if it's worth mentioning https://github.com/nodejs/node/discussions?

srknzl
srknzl commented Apr 3, 2021
View reviewed changes
GOVERNANCE.md Outdated
Comment on lines 126 to 148
### 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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I splitted this part to make it friendly for both collaborators and non-collaborators .

@F3n67u
Copy link
Member

F3n67u commented Jun 14, 2022

is this pull request still relevant?

@srknzl
Copy link
Contributor Author

srknzl commented Jun 19, 2022

is this pull request still relevant?

I have merged upstream/main into this branch. I think it still is.

@tniessen
Copy link
Member

Pinging some of the folks who engaged in #26287: @mcollina @richardlau @sxa

@tniessen tniessen mentioned this pull request Apr 27, 2023
Closed
tniessen
tniessen reviewed Apr 28, 2023
View reviewed changes
GOVERNANCE.md Outdated
Comment on lines 128 to 149
## 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
Copy link
Member

Choose a reason for hiding this comment

The 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.

@molllyn1 molllyn1 mentioned this pull request Jun 8, 2023
Open
This was referenced Jun 8, 2023
Open
Open
@ron-a20 ron-a20 mentioned this pull request Jun 8, 2023
Open
@baby636 baby636 mentioned this pull request Jun 9, 2023
Open
@137717unity 137717unity mentioned this pull request Jun 9, 2023
Open
@wedataintelligence wedataintelligence mentioned this pull request Jun 9, 2023
Open
@kissofire kissofire mentioned this pull request Jun 25, 2023
Open
@kissofire kissofire mentioned this pull request Sep 28, 2023
Open
@molllyn1 molllyn1 mentioned this pull request Sep 28, 2023
Open
@ron-a20 ron-a20 mentioned this pull request Sep 28, 2023
Open
@137717unity 137717unity mentioned this pull request Sep 28, 2023
Open
@aliceUnhinged613 aliceUnhinged613 mentioned this pull request Sep 28, 2023
Open
@baby636 baby636 mentioned this pull request Sep 28, 2023
Open
@wedataintelligence wedataintelligence mentioned this pull request Sep 29, 2023
Open
aduh95
aduh95 reviewed May 5, 2024
View reviewed changes
GOVERNANCE.md Outdated Show resolved Hide resolved
aduh95
aduh95 reviewed May 5, 2024
View reviewed changes
GOVERNANCE.md Outdated Show resolved Hide resolved
aduh95
aduh95 reviewed May 5, 2024
View reviewed changes
GOVERNANCE.md Outdated Show resolved Hide resolved
aduh95
aduh95 reviewed May 5, 2024
View reviewed changes
GOVERNANCE.md Outdated Show resolved Hide resolved
aduh95
aduh95 reviewed May 5, 2024
View reviewed changes
GOVERNANCE.md Outdated Show resolved Hide resolved
@aduh95 aduh95 added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 5, 2024
@aduh95 aduh95 merged commit bc39796 into nodejs:main May 5, 2024
17 checks passed
Ch3nYuY pushed a commit to Ch3nYuY/node that referenced this pull request May 8, 2024
@srknzl @Ch3nYuY
doc: make docs more welcoming and descriptive for newcomers
4bfadba 
Fixes: nodejs#26287
PR-URL: nodejs#38056
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
targos pushed a commit that referenced this pull request May 8, 2024
@srknzl @targos
doc: make docs more welcoming and descriptive for newcomers
f35b838 
Fixes: #26287
PR-URL: #38056
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
@targos targos mentioned this pull request May 13, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tniessen tniessen tniessen left review comments

@richardlau richardlau richardlau approved these changes

@aduh95 aduh95 aduh95 approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add a guide on "How do I become a Node.js committer".
6 participants
@srknzl @F3n67u @tniessen @richardlau @aduh95 @nodejs-github-bot