From 5ba2c04a5c2831d6237f4752d69a1038c9f48c2f Mon Sep 17 00:00:00 2001 From: Joyee Cheung Date: Sat, 20 Jan 2018 21:38:24 +0800 Subject: [PATCH 1/5] doc: improve the instructions of onboarding PR --- doc/onboarding.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/doc/onboarding.md b/doc/onboarding.md index e67f6638d3a0e4..a0ac0d9af2a0eb 100644 --- a/doc/onboarding.md +++ b/doc/onboarding.md @@ -199,12 +199,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: ` 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][]. ## Final notes @@ -227,6 +228,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 From acbdfd73a6728100291c99736fce0f3dc02badda Mon Sep 17 00:00:00 2001 From: Joyee Cheung Date: Sat, 20 Jan 2018 21:09:17 +0800 Subject: [PATCH 2/5] doc: document the collaborator nomination process --- GOVERNANCE.md | 117 ++++++++++++++++++++++++++++++++++++---------- doc/onboarding.md | 2 + 2 files changed, 94 insertions(+), 25 deletions(-) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 7b8903fa5c8bae..dc0350902588ae 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -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. + + +- [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) + + + ## 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,6 +52,8 @@ 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) @@ -56,11 +61,11 @@ TSC should serve as the final arbiter where required. 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 @@ -68,8 +73,9 @@ 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). The operations of the TSC are governed by the [TSC Charter][] as approved by the Node.js Foundation Board of Directors. @@ -128,10 +135,70 @@ 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: + +* 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). +* 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. + +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 their 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 +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 diff --git a/doc/onboarding.md b/doc/onboarding.md index a0ac0d9af2a0eb..93b6e809105bfc 100644 --- a/doc/onboarding.md +++ b/doc/onboarding.md @@ -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 From 81c68017812953356dcdeb3dd1dc7733065249e7 Mon Sep 17 00:00:00 2001 From: Joyee Cheung Date: Sun, 21 Jan 2018 00:25:51 +0800 Subject: [PATCH 3/5] fixup! avoid ambiguity in pronouns --- GOVERNANCE.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index dc0350902588ae..90c3f9cfba815a 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -148,7 +148,7 @@ not limited 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 their 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}+` @@ -179,8 +179,9 @@ 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 their contribution -profile, in order to make the nomination as frictionless as possible. +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 From 037976a34a1f4bd4594d8c26eb9265dbd8555906 Mon Sep 17 00:00:00 2001 From: Joyee Cheung Date: Tue, 23 Jan 2018 05:02:12 +0800 Subject: [PATCH 4/5] fixup! fix broken link in onboarding.md --- doc/onboarding.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/onboarding.md b/doc/onboarding.md index 93b6e809105bfc..296f9db7d02ef8 100644 --- a/doc/onboarding.md +++ b/doc/onboarding.md @@ -207,7 +207,7 @@ onboarding session. 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][]. + process. See the documentation of [`git-node`][]. ## Final notes From 6424d8c570d998dfeb1ad515122a9480cd95f7e8 Mon Sep 17 00:00:00 2001 From: Joyee Cheung Date: Tue, 23 Jan 2018 14:22:44 +0800 Subject: [PATCH 5/5] improve phrasing, capitalize Collaborator --- GOVERNANCE.md | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 90c3f9cfba815a..4f1ff30d83411c 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -73,9 +73,8 @@ may request that the TSC restore them to active status. ## Technical Steering Committee -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: +A subset of the Collaborators form the Technical Steering Committee (TSC). +The TSC has final authority over this project, including: * Technical direction * Project governance and process (including this policy) @@ -84,8 +83,8 @@ and has final authority over this project, including: * Conduct guidelines * Maintaining the list of additional Collaborators -The current list of TSC members can be found -[here](./README.md#current-project-team-members). +The current list of TSC members can be found in +[the project README](./README.md#current-project-team-members). The operations of the TSC are governed by the [TSC Charter][] as approved by the Node.js Foundation Board of Directors. @@ -141,9 +140,8 @@ 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: +To nominate a new Collaborator, open an issue in the [nodejs/node][] +repository, with a summary of the nominee's contributions, for example: * Commits in the [nodejs/node][] repository. * Can be shown using the link @@ -166,25 +164,25 @@ not limited to: `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. +Mention @nodejs/collaborators in the issue to notify other Collaborators about +the nomination. -If there are no objections raised by any collaborators one week after +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 +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 +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 +considered for a nomination, they may log an issue or contact a Collaborator directly. ### Onboarding