doc: document the collaborator nomination process by joyeecheung · Pull Request #18268 · nodejs/node

joyeecheung · 2018-01-20T13:43:32Z

Also describes the privileges of the collaborators and improve the instructions of the onboarding PR.

This is a draft done after the discussion in #18090 and this week's TSC meeting, any feedback is welcome!

Refs: nodejs/TSC#472
Fixes: #18090

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

doc

maclover7

Very nice update -- LGTM

joyeecheung · 2018-01-20T14:16:56Z

doc/onboarding.md

+    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][].


Oops, broken link (no backticks). Will fix it later.

Leko

LGTM

joyeecheung · 2018-01-20T15:41:33Z

Forgot to cc @nodejs/tsc @nodejs/collaborators

bnoordhuis · 2018-01-20T15:48:25Z

GOVERNANCE.md

+* 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 their GitHub ID).


the collaborator's GitHub ID? Singular they should be used sparingly, IMO.

bnoordhuis · 2018-01-20T15:52:01Z

GOVERNANCE.md

+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 their contribution


Another instance where I'd be explicit and write the nominee's contribution profile. A rushed reader might think it's about the collaborators team.

mcollina

LGTM

Trott · 2018-01-22T21:09:42Z

GOVERNANCE.md

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


For clarity, maybe put a period instead of a comma after (TSC) on the line above this one? Then start this line with The TSC admits and oversees all...

There are currently no "top-level projects" other than core. (express and libuv 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:

The TSC has final authority over this project, including:

@Trott I copied the sentence from the TSC readme, we should also update that one.

@joyeecheung Sounds like a good idea to me. nodejs/TSC#477

Trott · 2018-01-22T21:10:58Z

GOVERNANCE.md


-* [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).


Generally, it's good to avoid "here" as link text. Maybe use "in the project README" or something like that instead?

Trott · 2018-01-22T21:11:57Z

GOVERNANCE.md

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


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.

@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 , for example:

Trott · 2018-01-22T21:12:24Z

GOVERNANCE.md

+* 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.


Since TSC is a subset of Collaborators, it's sufficient to mention nodejs/collaborators only.

@Trott I am fine with that, just thinking people might be using different email filters for different mentions.

Trott · 2018-01-22T21:13:30Z

GOVERNANCE.md

+
+### Onboarding
+
+When the nomination is accepted, the new Collaborator will be onboarded


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

joyeecheung · 2018-01-23T06:23:52Z

@Trott Thanks for the review, updated. PTAL.
Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite/116/

joyeecheung · 2018-01-23T19:19:33Z

I am going to land this later today if there are no objections.

joyeecheung · 2018-01-24T10:43:03Z

Landed in a083786...6288050, thanks!

PR-URL: #18268 Fixes: #18090 Refs: nodejs/TSC#472 Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Shingo Inoue <leko.noor@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Weijia Wang <starkwang@126.com> Reviewed-By: Minwoo Jung <minwoo@nodesource.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>

PR-URL: nodejs#18268 Fixes: nodejs#18090 Refs: nodejs/TSC#472 Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Shingo Inoue <leko.noor@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Weijia Wang <starkwang@126.com> Reviewed-By: Minwoo Jung <minwoo@nodesource.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>

doc: improve the instructions of onboarding PR

5ba2c04

nodejs-github-bot added the meta Issues and PRs related to the general management of the project. label Jan 20, 2018

joyeecheung force-pushed the collaborator-nominations branch from 0306459 to 1e19ffc Compare January 20, 2018 13:48

doc: document the collaborator nomination process

acbdfd7

joyeecheung force-pushed the collaborator-nominations branch from 1e19ffc to acbdfd7 Compare January 20, 2018 13:49

maclover7 approved these changes Jan 20, 2018

View reviewed changes

joyeecheung commented Jan 20, 2018

View reviewed changes

Leko approved these changes Jan 20, 2018

View reviewed changes

gireeshpunathil approved these changes Jan 20, 2018

View reviewed changes

bnoordhuis approved these changes Jan 20, 2018

View reviewed changes

starkwang approved these changes Jan 20, 2018

View reviewed changes

fixup! avoid ambiguity in pronouns

81c6801

JungMinu approved these changes Jan 21, 2018

View reviewed changes

lpinca approved these changes Jan 21, 2018

View reviewed changes

mcollina approved these changes Jan 22, 2018

View reviewed changes

gibfahn approved these changes Jan 22, 2018

View reviewed changes

fixup! fix broken link in onboarding.md

037976a

Trott reviewed Jan 22, 2018

View reviewed changes

improve phrasing, capitalize Collaborator

6424d8c

joyeecheung added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 23, 2018

watilde approved these changes Jan 23, 2018

View reviewed changes

joyeecheung closed this Jan 24, 2018

joyeecheung removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 29, 2018

evanlucas mentioned this pull request Jan 30, 2018

v9.5.0 release proposal #18464

Merged

MylesBorins added dont-land-on-v6.x labels Feb 27, 2018

mcollina mentioned this pull request Mar 14, 2018

Nominate @trivikr #19067

Closed


		### Onboarding

		When the nomination is accepted, the new Collaborator will be onboarded

Uh oh!

Conversation

joyeecheung commented Jan 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Affected core subsystem(s)

Uh oh!

maclover7 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Leko left a comment

Choose a reason for hiding this comment

Uh oh!

joyeecheung commented Jan 20, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joyeecheung Jan 22, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joyeecheung commented Jan 23, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

joyeecheung commented Jan 23, 2018

Uh oh!

joyeecheung commented Jan 24, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

14 participants

joyeecheung commented Jan 20, 2018 •

edited

Loading

joyeecheung Jan 22, 2018 •

edited

Loading

joyeecheung commented Jan 23, 2018 •

edited

Loading

joyeecheung commented Jan 24, 2018 •

edited

Loading