-
Notifications
You must be signed in to change notification settings - Fork 29.8k
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’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: document the collaborator nomination process #18268
Changes from 3 commits
5ba2c04
acbdfd7
81c6801
037976a
6424d8c
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 |
---|---|---|
|
@@ -4,27 +4,30 @@ The Node.js project is governed by its Collaborators, including a Technical | |
Steering Committee (TSC) which is responsible for high-level guidance of the | ||
project. | ||
|
||
<!-- TOC --> | ||
|
||
- [Collaborators](#collaborators) | ||
- [Collaborator Activities](#collaborator-activities) | ||
- [Technical Steering Committee](#technical-steering-committee) | ||
- [TSC Meetings](#tsc-meetings) | ||
- [Collaborator Nominations](#collaborator-nominations) | ||
- [Onboarding](#onboarding) | ||
- [Consensus Seeking Process](#consensus-seeking-process) | ||
|
||
<!-- /TOC --> | ||
|
||
## Collaborators | ||
|
||
The [nodejs/node](https://github.com/nodejs/node) GitHub repository is | ||
maintained by Collaborators who are added by the TSC on an ongoing basis. | ||
The [nodejs/node][] GitHub repository is maintained by Node.js Core | ||
Collaborators. Upon becoming Collaborators, they: | ||
|
||
Individuals identified by the TSC as making significant and valuable | ||
contributions across any Node.js repository may be made Collaborators and given | ||
commit access to the project. Activities taken into consideration include (but | ||
are not limited to) the quality of: | ||
* Become members of the @nodejs/collaborators team | ||
* Gain individual membership of the Node.js foundation | ||
|
||
* code commits and pull requests | ||
* documentation commits and pull requests | ||
* comments on issues and pull requests | ||
* contributions to the Node.js website | ||
* assistance provided to end users and novice contributors | ||
* participation in Working Groups | ||
* other participation in the wider Node.js community | ||
Their privileges include but are not limited to: | ||
|
||
If individuals making valuable contributions do not believe they have been | ||
considered for commit access, they may log an issue or contact a TSC member | ||
directly. | ||
* Commit access to the [nodejs/node][] repository | ||
* Access to the Node.js continuous integration (CI) jobs | ||
|
||
Modifications of the contents of the nodejs/node repository are made on | ||
a collaborative basis. Anybody with a GitHub account may propose a | ||
|
@@ -49,27 +52,30 @@ Collaborators may opt to elevate significant or controversial modifications to | |
the TSC by assigning the `tsc-review` label to a pull request or issue. The | ||
TSC should serve as the final arbiter where required. | ||
|
||
See: | ||
|
||
* [Current list of Collaborators](./README.md#current-project-team-members) | ||
* [A guide for Collaborators](./COLLABORATOR_GUIDE.md) | ||
|
||
### Collaborator Activities | ||
|
||
Typical activities of a Collaborator include: | ||
|
||
* helping users and novice contributors | ||
* contributing code and documentation changes that improve the project | ||
* reviewing and commenting on issues and pull requests | ||
* participation in working groups | ||
* merging pull requests | ||
* Helping users and novice contributors | ||
* Contributing code and documentation changes that improve the project | ||
* Reviewing and commenting on issues and pull requests | ||
* Participation in working groups | ||
* Merging pull requests | ||
|
||
The TSC periodically reviews the Collaborator list to identify inactive | ||
Collaborators. Past Collaborators are typically given _Emeritus_ status. Emeriti | ||
may request that the TSC restore them to active status. | ||
|
||
## Technical Steering Committee | ||
|
||
The Technical Steering Committee (TSC) has final authority over this project | ||
including: | ||
A subgroup of the Collaborators form the Technical Steering Committee (TSC), | ||
who admits and oversees all top-level Projects in the Node.js Foundation, | ||
and has final authority over this project, including: | ||
|
||
* Technical direction | ||
* Project governance and process (including this policy) | ||
|
@@ -78,7 +84,8 @@ including: | |
* Conduct guidelines | ||
* Maintaining the list of additional Collaborators | ||
|
||
* [Current list of TSC members](./README.md#current-project-team-members) | ||
The current list of TSC members can be found | ||
[here](./README.md#current-project-team-members). | ||
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. Generally, it's good to avoid "here" as link text. Maybe use "in the project README" or something like that instead? |
||
|
||
The operations of the TSC are governed by the [TSC Charter][] as approved by | ||
the Node.js Foundation Board of Directors. | ||
|
@@ -128,10 +135,71 @@ the issue tracker is: | |
either the proposal is dropped or the objecting members are persuaded. If | ||
there is an extended impasse, a motion for a vote may be made. | ||
|
||
## Collaborator Nominations | ||
|
||
Any existing Collaborator can nominate an individual making significant | ||
and valuable contributions across the Node.js organization to become a new | ||
Collaborator. | ||
|
||
To nominate a new collaborator, open an issue in the [nodejs/node][] | ||
repository, with a summary of the nominee's contributions, including but | ||
not limited to: | ||
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 language "including but not limited to" suggests that all of the below bullet items should always be included. I'm OK with that, but just leaving this comment to make sure that is 100% the intention here. 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. @Trott Yes it does look like we are requiring people to list all of the items, which is not really what I meant... I'll change it to |
||
|
||
* Commits in the [nodejs/node][] repository. | ||
* Can be shown using the link | ||
`https://github.com/nodejs/node/commits?author=${GITHUB_ID}` | ||
(replace `${GITHUB_ID}` with the nominee's GitHub ID). | ||
* Pull requests and issues opened in the [nodejs/node][] repository. | ||
* Can be shown using the link | ||
`https://github.com/nodejs/node/pulls?q=author%3A${GITHUB_ID}+` | ||
* Comments and reviews on issues and pull requests in the | ||
[nodejs/node][] repository | ||
* Can be shown using the links | ||
`https://github.com/nodejs/node/pulls?q=reviewed-by%3A${GITHUB_ID}+` | ||
and `https://github.com/nodejs/node/pulls?q=commenter%3A${GITHUB_ID}+` | ||
* Assistance provided to end users and novice contributors | ||
* Participation in other projects, teams, and working groups of the | ||
Node.js organization | ||
* Can be shown using the links | ||
`https://github.com/search?q=author%3A${GITHUB_ID}++org%3Anodejs&type=Issues` | ||
and | ||
`https://github.com/search?q=commenter%3A${GITHUB_ID}++org%3Anodejs&type=Issues` | ||
* Other participation in the wider Node.js community | ||
|
||
Mention @nodejs/tsc and @nodejs/collaborators in the issue to notify the TSC | ||
and other collaborators about the nomination. | ||
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. Since TSC is a subset of Collaborators, it's sufficient to mention nodejs/collaborators only. 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. @Trott I am fine with that, just thinking people might be using different email filters for different mentions. |
||
|
||
If there are no objections raised by any collaborators one week after | ||
the issue is opened, the nomination will be considered as accepted. | ||
Should there be any objections against the nomination, the TSC is responsible | ||
for working with the individuals involved and finding a resolution. | ||
The nomination must be approved by the TSC, which is assumed when there are no | ||
objections from any TSC members. | ||
|
||
Prior to the public nomination, the collaborator initiating it can seek | ||
feedback from other collaborators in private using | ||
[the GitHub discussion page][collaborators-discussions] of the | ||
collaborators team, and work with the nominee to improve the nominee's | ||
contribution profile, in order to make the nomination as frictionless | ||
as possible. | ||
|
||
If individuals making valuable contributions do not believe they have been | ||
considered for a nomination, they may log an issue or contact a collaborator | ||
directly. | ||
|
||
### Onboarding | ||
|
||
When the nomination is accepted, the new Collaborator will be onboarded | ||
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. "Collaborator" is capitalized here but not elsewhere in the new text (such as the previous paragraph). We seem to have standardized on capitalizing it, so I'd recommend doing that throughout the doc, or at least in the new text. |
||
by a TSC member. See [the onboarding guide](./doc/onboarding.md) on | ||
details of the onboarding process. In general, the onboarding should be | ||
completed within a month after the nomination is accepted. | ||
|
||
## Consensus Seeking Process | ||
|
||
The TSC follows a [Consensus Seeking][] decision making model as described by | ||
the [TSC Charter][]. | ||
|
||
[TSC Charter]: https://github.com/nodejs/TSC/blob/master/TSC-Charter.md | ||
[collaborators-discussions]: https://github.com/orgs/nodejs/teams/collaborators/discussions | ||
[Consensus Seeking]: https://en.wikipedia.org/wiki/Consensus-seeking_decision-making | ||
[TSC Charter]: https://github.com/nodejs/TSC/blob/master/TSC-Charter.md | ||
[nodejs/node]: https://github.com/nodejs/node |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,6 +9,8 @@ onboarding session. | |
GitHub account. Unless two-factor authentication is enabled, do not give an | ||
account elevated privileges such as the ability to land code in the main | ||
repository or to start continuous integration (CI) jobs. | ||
* Announce the accepted nomination in a TSC meeting and in the TSC | ||
mailing list. | ||
|
||
## Fifteen minutes before the onboarding session | ||
|
||
|
@@ -199,12 +201,13 @@ onboarding session. | |
* Optionally, include your personal pronouns. | ||
* Label your pull request with the `doc` subsystem label. | ||
* Run CI on your PR. | ||
* After one or two approvals, land the PR. | ||
* After one or two approvals, land the PR (PRs of this type do not need to wait | ||
for 48/72 hours to land). | ||
* Be sure to add the `PR-URL: <full-pr-url>` and appropriate `Reviewed-By:` | ||
metadata! | ||
* [`core-validate-commit`][] helps a lot with this – install and use it if you | ||
can! | ||
* [`node-core-utils`][] fetches the metadata for you. | ||
metadata. | ||
* [`core-validate-commit`][] automates the validation of commit messages. | ||
* [`node-core-utils`][] automates the generation of metadata and the landing | ||
process. See the documentation of [git-node][]. | ||
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. Oops, broken link (no backticks). Will fix it later. |
||
|
||
## Final notes | ||
|
||
|
@@ -227,6 +230,7 @@ onboarding session. | |
|
||
[Code of Conduct]: https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md | ||
[`core-validate-commit`]: https://github.com/evanlucas/core-validate-commit | ||
[`git-node`]: https://github.com/nodejs/node-core-utils#git-node | ||
[`node-core-utils`]: https://github.com/nodejs/node-core-utils | ||
[Landing Pull Requests]: https://github.com/nodejs/node/blob/master/COLLABORATOR_GUIDE.md#landing-pull-requests | ||
[https://github.com/nodejs/node/commit/ce986de829457c39257cd205067602e765768fb0]: https://github.com/nodejs/node/commit/ce986de829457c39257cd205067602e765768fb0 | ||
|
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.
For clarity, maybe put a period instead of a comma after
(TSC)
on the line above this one? Then start this line withThe TSC admits and oversees all...
There are currently no "top-level projects" other than core. (
express
andlibuv
never completed the process and therefore never graduated to top-level project status.) There is unlikely to ever be any other top-level projects. I think the terminology should be removed as it is confusing. Using it implies that that whole top-level project is a process that exists, a thing we do. I would just say: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.
@Trott I copied the sentence from the TSC readme, we should also update that one.
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.
@joyeecheung Sounds like a good idea to me. nodejs/TSC#477