1# Onboarding 2 3This document is an outline of the things we tell new collaborators at their 4onboarding session. 5 6## One week before the onboarding session 7 8* If the new Collaborator is not yet a member of the nodejs GitHub organization, 9 confirm that they are using [two-factor authentication][]. It will not be 10 possible to add them to the organization if they are not using two-factor 11 authentication. If they cannot receive SMS messages from GitHub, try 12 [using a TOTP mobile app][]. 13* Announce the accepted nomination in a TSC meeting and in the TSC 14 mailing list. 15* Suggest the new Collaborator install [`node-core-utils`][] and 16 [set up the credentials][] for it. 17 18## Fifteen minutes before the onboarding session 19 20* Prior to the onboarding session, add the new Collaborator to 21 [the collaborators team](https://github.com/orgs/nodejs/teams/collaborators). 22* Ask them if they want to join any subsystem teams. See 23 [Who to CC in the issue tracker][who-to-cc]. 24 25## Onboarding session 26 27* This session will cover: 28 * [local setup](#local-setup) 29 * [project goals and values](#project-goals-and-values) 30 * [managing the issue tracker](#managing-the-issue-tracker) 31 * [reviewing pull requests](#reviewing-pull-requests) 32 * [landing pull requests](#landing-pull-requests) 33 34## Local setup 35 36* git: 37 * Make sure you have whitespace=fix: `git config --global --add 38 apply.whitespace fix` 39 * Always create a branch in your own GitHub fork for pull requests 40 * Branches in the `nodejs/node` repository are only for release lines 41 * Add the canonical nodejs repository as `upstream` remote: 42 * `git remote add upstream git://github.com/nodejs/node.git` 43 * To update from `upstream`: 44 * `git checkout master` 45 * `git remote update -p` OR `git fetch --all` 46 * `git merge --ff-only upstream/master` (or `REMOTENAME/BRANCH`) 47 * Make a new branch for each pull request you submit. 48 * Membership: Consider making your membership in the Node.js GitHub 49 organization public. This makes it easier to identify collaborators. 50 Instructions on how to do that are available at 51 [Publicizing or hiding organization membership][]. 52 53* Notifications: 54 * Use [https://github.com/notifications](https://github.com/notifications) or 55 set up email 56 * Watching the main repository will flood your inbox (several hundred 57 notifications on typical weekdays), so be prepared 58 59The project has two venues for real-time discussion: 60* [`#nodejs-dev`](https://openjs-foundation.slack.com/archives/C019Y2T6STH) on 61 the [OpenJS Foundation](https://slack-invite.openjsf.org/) 62 63## Project goals and values 64 65* Collaborators are the collective owners of the project 66 * The project has the goals of its contributors 67 68* There are some higher-level goals and values 69 * Empathy towards users matters (this is in part why we onboard people) 70 * Generally: try to be nice to people! 71 * The best outcome is for people who come to our issue tracker to feel like 72 they can come back again. 73 74* You are expected to follow *and* hold others accountable to the 75 [Code of Conduct][]. 76 77## Managing the issue tracker 78 79* You have (mostly) free rein; don't hesitate to close an issue if you are 80 confident that it should be closed. 81 * Be nice about closing issues! Let people know why, and that issues and pull 82 requests can be reopened if necessary. 83 84* See [Labels][]. 85 * There is [a bot](https://github.com/nodejs-github-bot/github-bot) that 86 applies subsystem labels (for example, `doc`, `test`, `assert`, or `buffer`) 87 so that we know what parts of the code base the pull request modifies. It is 88 not perfect, of course. Feel free to apply relevant labels and remove 89 irrelevant labels from pull requests and issues. 90 * `semver-{minor,major}`: 91 * If a change has the remote *chance* of breaking something, use the 92 `semver-major` label 93 * When adding a `semver-*` label, add a comment explaining why you're adding 94 it. Do it right away so you don't forget! 95 * Please add the [`author-ready`][] label for pull requests, if applicable. 96 97* See [Who to CC in the issue tracker][who-to-cc]. 98 * This will come more naturally over time 99 * For many of the teams listed there, you can ask to be added if you are 100 interested 101 * Some are WGs with some process around adding people, others are only there 102 for notifications 103 104* When a discussion gets heated, you can request that other collaborators keep 105 an eye on it by opening an issue at the private 106 [nodejs/moderation](https://github.com/nodejs/moderation) repository. 107 * This is a repository to which all members of the `nodejs` GitHub 108 organization (not just collaborators on Node.js core) have access. Its 109 contents should not be shared externally. 110 * You can find the full moderation policy 111 [here](https://github.com/nodejs/admin/blob/HEAD/Moderation-Policy.md). 112 113## Reviewing pull requests 114 115* The primary goal is for the codebase to improve. 116* Secondary (but not far off) is for the person submitting code to succeed. A 117 pull request from a new contributor is an opportunity to grow the community. 118* Review a bit at a time. Do not overwhelm new contributors. 119 * It is tempting to micro-optimize. Don't succumb to that temptation. We 120 change V8 often. Techniques that provide improved performance today may be 121 unnecessary in the future. 122* Be aware: Your opinion carries a lot of weight! 123* Nits (requests for small changes that are not essential) are fine, but try to 124 avoid stalling the pull request. 125 * Identify them as nits when you comment: `Nit: change foo() to bar().` 126 * If they are stalling the pull request, fix them yourself on merge. 127* Insofar as possible, issues should be identified by tools rather than human 128 reviewers. If you are leaving comments about issues that could be identified 129 by tools but are not, consider implementing the necessary tooling. 130* Minimum wait for comments time 131 * There is a minimum waiting time which we try to respect for non-trivial 132 changes so that people who may have important input in such a distributed 133 project are able to respond. 134 * For non-trivial changes, leave the pull request open for at least 48 hours. 135 * If a pull request is abandoned, check if they'd mind if you took it over 136 (especially if it just has nits left). 137* Approving a change 138 * Collaborators indicate that they have reviewed and approve of the changes in 139 a pull request using GitHub’s approval interface 140 * Some people like to comment `LGTM` (“Looks Good To Me”) 141 * You have the authority to approve any other collaborator’s work. 142 * You cannot approve your own pull requests. 143 * When explicitly using `Changes requested`, show empathy – comments will 144 usually be addressed even if you don’t use it. 145 * If you do, it is nice if you are available later to check whether your 146 comments have been addressed 147 * If you see that the requested changes have been made, you can clear 148 another collaborator's `Changes requested` review. 149 * Use `Changes requested` to indicate that you are considering some of your 150 comments to block the pull request from landing. 151 152* What belongs in Node.js: 153 * Opinions vary – it’s good to have a broad collaborator base for that reason! 154 * If Node.js itself needs it (due to historical reasons), then it belongs in 155 Node.js. 156 * That is to say, `url` is there because of `http`, `freelist` is there 157 because of `http`, etc. 158 * Things that cannot be done outside of core, or only with significant pain 159 such as `async_hooks`. 160 161* Continuous Integration (CI) Testing: 162 * [https://ci.nodejs.org/](https://ci.nodejs.org/) 163 * It is not automatically run. You need to start it manually. 164 * Log in on CI is integrated with GitHub. Try to log in now! 165 * You will be using `node-test-pull-request` most of the time. Go there now! 166 * Consider bookmarking it: <https://ci.nodejs.org/job/node-test-pull-request/> 167 * To get to the form to start a job, click on `Build with Parameters`. (If you 168 don't see it, that probably means you are not logged in!) Click it now! 169 * To start CI testing from this screen, you need to fill in two elements on 170 the form: 171 * The `CERTIFY_SAFE` box should be checked. By checking it, you are 172 indicating that you have reviewed the code you are about to test and you 173 are confident that it does not contain any malicious code. (We don't want 174 people hijacking our CI hosts to attack other hosts on the internet, for 175 example!) 176 * The `PR_ID` box should be filled in with the number identifying the pull 177 request containing the code you wish to test. For example, if the URL for 178 the pull request is `https://github.com/nodejs/node/issues/7006`, then put 179 `7006` in the `PR_ID`. 180 * The remaining elements on the form are typically unchanged. 181 * If you need help with something CI-related: 182 * Use the [Build WG repository](https://github.com/nodejs/build) to file 183 issues for the Build WG members who maintain the CI infrastructure. 184 185## Landing pull requests 186 187See the Collaborator Guide: [Landing pull requests][]. 188 189Commits in one pull request that belong to one logical change should 190be squashed. It is rarely the case in onboarding exercises, so this 191needs to be pointed out separately during the onboarding. 192 193<!-- TODO(joyeechueng): provide examples about "one logical change" --> 194 195## Exercise: Make a pull request adding yourself to the README 196 197* Example: 198 <https://github.com/nodejs/node/commit/b58fe52692659c0bc25ddbe6afa7f4ae2c7f14a8> 199 * For raw commit message: 200 `git show --format=%Bb58fe52692659c0bc25ddbe6afa7f4ae2c7f14a8` 201* Collaborators are in alphabetical order by GitHub username. 202* Optionally, include your personal pronouns. 203* Add the `Fixes: <collaborator-nomination-issue-url>` to the commit message 204 so that when the commit lands, the nomination issue url will be 205 automatically closed. 206* Label your pull request with the `doc`, `notable-change`, and `fast-track` 207 labels. The `fast-track` label should cause the Node.js GitHub bot to post a 208 comment in the pull request asking collaborators to approve the pull request 209 by leaving a �� reaction on the comment. 210* Run CI on the pull request. Use the `node-test-pull-request` CI task. 211* After two Collaborator approvals for the change and two Collaborator approvals 212 for fast-tracking, land the PR. 213* If there are not enough approvals within a reasonable time, consider the 214 single approval of the onboarding TSC member sufficient, and land the pull 215 request. 216 * Be sure to add the `PR-URL: <full-pr-url>` and appropriate `Reviewed-By:` 217 metadata. 218 * [`node-core-utils`][] automates the generation of metadata and the landing 219 process. See the documentation of [`git-node`][]. 220 * [`core-validate-commit`][] automates the validation of commit messages. 221 This will be run during `git node land --final` of the [`git-node`][] 222 command. 223 224## Final notes 225 226* Don't worry about making mistakes: everybody makes them, there's a lot to 227 internalize and that takes time (and we recognize that!) 228* Almost any mistake you could make can be fixed or reverted. 229* The existing collaborators trust you and are grateful for your help! 230* Other repositories: 231 * [https://github.com/nodejs/TSC](https://github.com/nodejs/TSC) 232 * [https://github.com/nodejs/build](https://github.com/nodejs/build) 233 * [https://github.com/nodejs/nodejs.org](https://github.com/nodejs/nodejs.org) 234 * [https://github.com/nodejs/readable-stream](https://github.com/nodejs/readable-stream) 235 * [https://github.com/nodejs/LTS](https://github.com/nodejs/LTS) 236 * [https://github.com/nodejs/citgm](https://github.com/nodejs/citgm) 237* The OpenJS Foundation hosts regular summits for active contributors to the 238 Node.js project, where we have face-to-face discussions about our work on the 239 project. The Foundation has travel funds to cover participants' expenses 240 including accommodations, transportation, visa fees, etc. if needed. Check out 241 the [summit](https://github.com/nodejs/summit) repository for details. 242 243[Code of Conduct]: https://github.com/nodejs/admin/blob/HEAD/CODE_OF_CONDUCT.md 244[Labels]: doc/guides/collaborator-guide.md#labels 245[Landing pull requests]: doc/guides/collaborator-guide.md#landing-pull-requests 246[Publicizing or hiding organization membership]: https://help.github.com/articles/publicizing-or-hiding-organization-membership/ 247[`author-ready`]: doc/guides/collaborator-guide.md#author-ready-pull-requests 248[`core-validate-commit`]: https://github.com/nodejs/core-validate-commit 249[`git-node`]: https://github.com/nodejs/node-core-utils/blob/HEAD/docs/git-node.md 250[`node-core-utils`]: https://github.com/nodejs/node-core-utils 251[set up the credentials]: https://github.com/nodejs/node-core-utils#setting-up-credentials 252[two-factor authentication]: https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/ 253[using a TOTP mobile app]: https://help.github.com/articles/configuring-two-factor-authentication-via-a-totp-mobile-app/ 254[who-to-cc]: doc/guides/collaborator-guide.md#who-to-cc-in-the-issue-tracker 255