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’ll 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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f2a5930
doc: make docs more welcoming and descriptive for newcomers
srknzl Apr 3, 2021
2ddd64c
doc: delete trailing space in header
srknzl Apr 3, 2021
8e056fa
doc: fix link in toc
srknzl Apr 3, 2021
4d5b4e3
Merge remote-tracking branch 'upstream/main' into improve-contributing
srknzl Jun 19, 2022
cc689c9
Linting
srknzl Jun 19, 2022
91e53d8
Apply suggestions from code review
aduh95 May 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
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
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)

good faith with other contributors and the community. No contribution is too
small and all contributions are valued.
Comment on lines +3 to +9
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


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


## Contents

* [Code of Conduct](#code-of-conduct)
* [Issues](#issues)
* [Pull Requests](#pull-requests)
Expand All @@ -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
Loading

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
Loading

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

general discussions are made.

* [Asking for General Help](./doc/guides/contributing/issues.md#asking-for-general-help)
* [Discussing non-technical topics](./doc/guides/contributing/issues.md#discussing-non-technical-topics)
* [Submitting a Bug Report](./doc/guides/contributing/issues.md#submitting-a-bug-report)
* [Triaging a Bug Report](./doc/guides/contributing/issues.md#triaging-a-bug-report)

## [Pull Requests](./doc/guides/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/guides/contributing/pull-requests.md#dependencies)
* [Setting up your local environment](./doc/guides/contributing/pull-requests.md#setting-up-your-local-environment)
* [The Process of Making Changes](./doc/guides/contributing/pull-requests.md#the-process-of-making-changes)
Expand Down
26 changes: 24 additions & 2 deletions GOVERNANCE.md
View file
Open in desktop
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-?)
aduh95 marked this conversation as resolved.
Show resolved Hide resolved
* [Ideal Nominees](#ideal-nominees)
* [Nominating a new Collaborator](#nominating-a-new-collaborator)
* [Onboarding](#onboarding)
* [Consensus seeking process](#consensus-seeking-process)

Expand Down Expand Up @@ -120,10 +123,29 @@ 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 ?
aduh95 marked this conversation as resolved.
Show resolved Hide resolved

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
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
* Other participation in the wider Node.js community
aduh95 marked this conversation as resolved.
Show resolved Hide resolved

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

To nominate a new Collaborator, open an issue in the [nodejs/node][] repository.
Provide a summary of the nominee's contributions. For example:

Expand Down