GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Make docs more welcoming and descriptive for newcomers by srknzl · Pull Request #38056 · nodejs/node

Conversation

@srknzl

@srknzl srknzl commented Apr 3, 2021

Copy link
Copy Markdown

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

Fixes: #26287

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Serkan Özel
doc: make docs more welcoming and descriptive for newcomers
f2a5930 
Fixes: nodejs#26287
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to Node.js documentation. 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
Comment thread 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

@srknzl srknzl Apr 3, 2021

Copy link
Copy Markdown
Author

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)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
srknzl
srknzl commented Apr 3, 2021
View reviewed changes
Comment thread 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.

@srknzl srknzl Apr 3, 2021

Copy link
Copy Markdown
Author

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.

This part is from 7e1b178#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L3

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
srknzl
srknzl commented Apr 3, 2021
View reviewed changes
Comment thread 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.

@srknzl srknzl Apr 3, 2021

Copy link
Copy Markdown
Author

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.

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
srknzl
srknzl commented Apr 3, 2021
View reviewed changes
Comment thread CONTRIBUTING.md Outdated

## [Issues](./doc/guides/contributing/issues.md)

Issues in `nodejs/node` are the primary means by which bug reports and

@srknzl srknzl Apr 3, 2021 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Author

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.

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@aduh95 aduh95 Apr 3, 2021

Copy link
Copy Markdown
Contributor

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.

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
srknzl reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

@srknzl srknzl Apr 3, 2021

Copy link
Copy Markdown
Author

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.

https://github.com/nodejs/node/discussions/38057

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@aduh95 aduh95 Apr 3, 2021

Copy link
Copy Markdown
Contributor

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.

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
srknzl reacted with laugh emoji
All reactions
  • 😄 1 reaction

@srknzl srknzl Apr 3, 2021 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Author

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.

Maybe we can add a section with this content of this discussion: https://github.com/nodejs/node/discussions/35662

also we can give a link to discussions page (https://github.com/nodejs/node/discussions/)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
aduh95 reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
aduh95
aduh95 reviewed Apr 3, 2021
View reviewed changes

@aduh95 aduh95 left a comment

Copy link
Copy Markdown
Contributor

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.

Thanks for doing this :)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
srknzl reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
Comment thread GOVERNANCE.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread GOVERNANCE.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread CONTRIBUTING.md Outdated

## [Issues](./doc/guides/contributing/issues.md)

Issues in `nodejs/node` are the primary means by which bug reports and

@aduh95 aduh95 Apr 3, 2021

Copy link
Copy Markdown
Contributor

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.

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
srknzl reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
srknzl
srknzl commented Apr 3, 2021
View reviewed changes
Comment thread 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

@srknzl srknzl Apr 3, 2021

Copy link
Copy Markdown
Author

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.

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Serkan Özel added 2 commits April 3, 2021 13:27
Serkan Özel
doc: delete trailing space in header
2ddd64c
Serkan Özel
doc: fix link in toc
8e056fa
@F3n67u

F3n67u commented Jun 14, 2022

Copy link
Copy Markdown
Contributor

is this pull request still relevant?
srknzl reacted with confused emoji
All reactions
  • 😕 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
Serkan Özel
Merge remote-tracking branch 'upstream/main' into improve-contributing
4d5b4e3
@srknzl

srknzl commented Jun 19, 2022

Copy link
Copy Markdown
Author

is this pull request still relevant?

I have merged upstream/main into this branch. I think it still is.
F3n67u reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
Serkan Özel
Linting
cc689c9
@Trott
Trott force-pushed the main branch from 2d76238 to ca3ed36 Compare November 12, 2022 01:49
@tniessen

tniessen commented Apr 27, 2023

Copy link
Copy Markdown
Member

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@tniessen tniessen mentioned this pull request Apr 27, 2023
Add a guide on "How do I become a Node.js committer". #26287
Closed
richardlau
richardlau approved these changes Apr 28, 2023
View reviewed changes
tniessen
tniessen reviewed Apr 28, 2023
View reviewed changes
Comment thread 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

@tniessen tniessen Apr 28, 2023

Copy link
Copy Markdown
Member

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.

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@molllyn1 molllyn1 mentioned this pull request Jun 8, 2023
[Snyk] Fix for 4 vulnerabilities molllyn1/node#79
Open
This was referenced Jun 8, 2023
[Snyk] Fix for 4 vulnerabilities kissofire/node#98
Open
[Snyk] Fix for 4 vulnerabilities aliceUnhinged613/node#93
Open
@ron-a20 ron-a20 mentioned this pull request Jun 8, 2023
[Snyk] Fix for 4 vulnerabilities ron-a20/node#96
Open
@baby636 baby636 mentioned this pull request Jun 9, 2023
[Snyk] Fix for 4 vulnerabilities baby636/node#93
Open
@137717unity 137717unity mentioned this pull request Jun 9, 2023
[Snyk] Fix for 4 vulnerabilities 137717unity/node#96
Open
@wedataintelligence wedataintelligence mentioned this pull request Jun 9, 2023
[Snyk] Fix for 4 vulnerabilities wedataintelligence/node#78
Open
@kissofire kissofire mentioned this pull request Jun 25, 2023
[Snyk] Fix for 28 vulnerabilities kissofire/node#102
Open
@kissofire kissofire mentioned this pull request Sep 28, 2023
[Snyk] Fix for 1 vulnerabilities kissofire/node#103
Open
@molllyn1 molllyn1 mentioned this pull request Sep 28, 2023
[Snyk] Fix for 1 vulnerabilities molllyn1/node#83
Open
@ron-a20 ron-a20 mentioned this pull request Sep 28, 2023
[Snyk] Fix for 1 vulnerabilities ron-a20/node#99
Open
@137717unity 137717unity mentioned this pull request Sep 28, 2023
[Snyk] Fix for 1 vulnerabilities 137717unity/node#100
Open
@aliceUnhinged613 aliceUnhinged613 mentioned this pull request Sep 28, 2023
[Snyk] Fix for 1 vulnerabilities aliceUnhinged613/node#96
Open
@baby636 baby636 mentioned this pull request Sep 28, 2023
[Snyk] Fix for 1 vulnerabilities baby636/node#105
Open
@wedataintelligence wedataintelligence mentioned this pull request Sep 29, 2023
[Snyk] Fix for 1 vulnerabilities wedataintelligence/node#82
Open
aduh95
aduh95 reviewed May 5, 2024
View reviewed changes
Comment thread GOVERNANCE.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
aduh95
aduh95 reviewed May 5, 2024
View reviewed changes
Comment thread GOVERNANCE.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
aduh95
aduh95 reviewed May 5, 2024
View reviewed changes
Comment thread GOVERNANCE.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
aduh95
aduh95 reviewed May 5, 2024
View reviewed changes
Comment thread GOVERNANCE.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
aduh95
aduh95 reviewed May 5, 2024
View reviewed changes
Comment thread GOVERNANCE.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
@aduh95
Apply suggestions from code review
91e53d8
@aduh95 aduh95 added the author ready PRs with CI started, the required approvals, and no outstanding review comments. label May 5, 2024
aduh95
aduh95 approved these changes May 5, 2024
View reviewed changes
@aduh95
aduh95 merged commit bc39796 into nodejs:main May 5, 2024
targos pushed a commit that referenced this pull request May 8, 2024
Serkan Özel @targos
doc: make docs more welcoming and descriptive for newcomers
f35b838 
Fixes: #26287
PR-URL: #38056
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
@targos targos mentioned this pull request May 13, 2024
v22.2.0 release proposal #52971
Merged
marco-ippolito pushed a commit that referenced this pull request Jun 17, 2024
Serkan Özel @marco-ippolito
doc: make docs more welcoming and descriptive for newcomers
91fadac 
Fixes: #26287
PR-URL: #38056
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
@marco-ippolito marco-ippolito mentioned this pull request Jun 17, 2024
v20.15.0 proposal #53486
Merged
soophoo pushed a commit to soophoo/node that referenced this pull request Jun 20, 2024
Serkan Özel @soophoo
doc: make docs more welcoming and descriptive for newcomers
3483e1a 
Fixes: nodejs#26287
PR-URL: nodejs#38056
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
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

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

author ready PRs with CI started, the required approvals, and no outstanding review comments. doc Issues and PRs related to Node.js documentation. 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".

Uh oh!

There was an error while loading. Please reload this page.

6 participants

@srknzl @F3n67u @tniessen @richardlau @aduh95 @nodejs-github-bot
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.