Skip to content

Commit 31ae193

Browse files
committed
doc: small makeover for onboarding.md
PR-URL: #13413 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
1 parent 18f073f commit 31ae193

File tree

1 file changed

+61
-44
lines changed

1 file changed

+61
-44
lines changed

doc/onboarding.md

+61-44
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,17 @@ onboarding session.
1313
## Fifteen minutes before the onboarding session
1414

1515
* Prior to the onboarding session, add the new Collaborator to
16-
[the Collaborators team](https://github.com/orgs/nodejs/teams/collaborators).
16+
[the Collaborators team](https://github.com/orgs/nodejs/teams/collaborators),
17+
and to [the Members team](https://github.com/orgs/nodejs/teams/members) if
18+
they are not already part of it.
1719
Note that this is the step that gives the account elevated privileges, so
1820
do not perform this step (or any subsequent steps) unless two-factor
1921
authentication is enabled on the new Collaborator's GitHub account.
2022

2123

2224
## Onboarding session
2325

24-
* **thank you** for doing this
25-
* will cover:
26+
* This session will cover:
2627
* [local setup](#local-setup)
2728
* [project goals & values](#project-goals--values)
2829
* [managing the issue tracker](#managing-the-issue-tracker)
@@ -32,33 +33,37 @@ onboarding session.
3233
## Local setup
3334

3435
* git:
35-
* make sure you have whitespace=fix: `git config --global --add apply.whitespace fix`
36-
* usually PR from your own github fork
36+
* Make sure you have whitespace=fix: `git config --global --add apply.whitespace fix`
37+
* Always continue to PR from your own github fork
38+
* Branches in the nodejs/node repository are only for release lines
3739
* [See "Updating Node.js from Upstream"](./onboarding-extras.md#updating-nodejs-from-upstream)
38-
* make new branches for all commits you make!
40+
* Make a new branch for each PR you submit.
3941

40-
* notifications:
41-
* use [https://github.com/notifications](https://github.com/notifications) or set up email
42-
* watching the main repo will flood your inbox, so be prepared
42+
* Notifications:
43+
* Use [https://github.com/notifications](https://github.com/notifications) or set up email
44+
* Watching the main repo will flood your inbox (several hundred notifications on typical weekdays), so be prepared
4345

44-
* `#node-dev` on [webchat.freenode.net](https://webchat.freenode.net/) is the best place to interact with the CTC / other collaborators
46+
* `#node-dev` on [webchat.freenode.net](https://webchat.freenode.net/) is the best place to interact with the CTC / other Collaborators
47+
* If there are any questions after the session, a good place to ask is there!
48+
* Presence is not mandatory, but please drop a note there if force-pushing to `master`
4549

4650

4751
## Project goals & values
4852

49-
* collaborators are effectively part owners
50-
* the project has the goals of its contributors
53+
* Collaborators are the collective owners of the project
54+
* The project has the goals of its contributors
5155

52-
* but, there are some higher-level goals and values
53-
* not everything belongs in core (if it can be done reasonably in userland, let it stay in userland)
54-
* empathy towards users matters (this is in part why we onboard people)
55-
* generally: try to be nice to people
56+
* There are some higher-level goals and values
57+
* Empathy towards users matters (this is in part why we onboard people)
58+
* Generally: try to be nice to people!
59+
* The best outcome is for people who come to our issue tracker to feel like they can come back again.
60+
61+
* We have a [Code of Conduct][] that you are expected to follow *and* hold others accountable to
5662

5763
## Managing the issue tracker
5864

59-
* you have (mostly) free rein – don't hesitate to close an issue if you are confident that it should be closed
60-
* **IMPORTANT**: be nice about closing issues, let people know why, and that issues and PRs can be reopened if necessary
61-
* Still need to follow the Code of Conduct
65+
* You have (mostly) free rein; don't hesitate to close an issue if you are confident that it should be closed
66+
* Be nice about closing issues! Let people know why, and that issues and PRs can be reopened if necessary
6267

6368
* [**See "Labels"**](./onboarding-extras.md#labels)
6469
* There is [a bot](https://github.com/nodejs-github-bot/github-bot) that applies subsystem labels (for example, `doc`, `test`, `assert`, or `buffer`) so that we know what parts of the code base the pull request modifies. It is not perfect, of course. Feel free to apply relevant labels and remove irrelevant labels from pull requests and issues.
@@ -69,9 +74,11 @@ onboarding session.
6974
* When adding a semver label, add a comment explaining why you're adding it. Do it right away so you don't forget!
7075

7176
* [**See "Who to CC in issues"**](./onboarding-extras.md#who-to-cc-in-issues)
72-
* will also come more naturally over time
77+
* This will come more naturally over time
78+
* For many of the teams listed there, you can ask to be added if you are interested
79+
* Some are WGs with some process around adding people, others are only there for notifications
7380

74-
* When a discussion gets heated, you can request that other collaborators keep an eye on it by opening an issue at the private [nodejs/moderation](https://github.com/nodejs/moderation) repository.
81+
* When a discussion gets heated, you can request that other Collaborators keep an eye on it by opening an issue at the private [nodejs/moderation](https://github.com/nodejs/moderation) repository.
7582
* This is a repository to which all members of the `nodejs` GitHub organization (not just Collaborators on Node.js core) have access. Its contents should not be shared externally.
7683
* You can find the full moderation policy [here](https://github.com/nodejs/TSC/blob/master/Moderation-Policy.md).
7784

@@ -100,18 +107,24 @@ onboarding session.
100107
(especially if it just has nits left).
101108
* Approving a change
102109
* Collaborators indicate that they have reviewed and approve of the
103-
the changes in a pull request by commenting with `LGTM`, which stands
104-
for "looks good to me".
105-
* You have the power to `LGTM` another collaborator's (including TSC/CTC
106-
members) work.
107-
* You may not `LGTM` your own pull requests.
108-
* You have the power to `LGTM` anyone else's pull requests.
109-
110-
* What belongs in node:
111-
* opinions vary, but I find the following helpful:
112-
* if node itself needs it (due to historic reasons), then it belongs in node
113-
* that is to say, url is there because of http, freelist is there because of http, et al
114-
* also, things that cannot be done outside of core, or only with significant pain (example: async-wrap)
110+
the changes in a pull request using Github’s approval interface
111+
* Some people like to comment `LGTM` (“Looks Good To Me”)
112+
* You have the authority to approve any other collaborator’s work.
113+
* You cannot approve your own pull requests.
114+
* When explicitly using `Changes requested`, show empathy – comments will
115+
usually be addressed even if you don’t use it.
116+
* If you do, it is nice if you are available later to check whether your
117+
comments have been addressed
118+
* If you see that the requested changes have been made, you can clear another collaborator's
119+
`Changes requested` review.
120+
* Use `Changes requested` to indicate that you are considering some of
121+
your comments to block the PR from landing.
122+
123+
* What belongs in Node.js:
124+
* Opinions vary – it’s good to have a broad collaborator base for that reason!
125+
* If Node.js itself needs it (due to historic reasons), then it belongs in Node.js
126+
* That is to say, url is there because of http, freelist is there because of http, etc.
127+
* Things that cannot be done outside of core, or only with significant pain (for example `async_hooks`)
115128

116129
* Continuous Integration (CI) Testing:
117130
* [https://ci.nodejs.org/](https://ci.nodejs.org/)
@@ -136,26 +149,30 @@ onboarding session.
136149

137150
## Exercise: Make a PR adding yourself to the README
138151

139-
* Example: [https://github.com/nodejs/node/commit/7b09aade8468e1c930f36b9c81e6ac2ed5bc8732](https://github.com/nodejs/node/commit/7b09aade8468e1c930f36b9c81e6ac2ed5bc8732)
140-
* For raw commit message: `git log 7b09aade8468e1c930f36b9c81e6ac2ed5bc8732 -1`
152+
* Example: [https://github.com/nodejs/node/commit/ce986de829457c39257cd205067602e765768fb0](https://github.com/nodejs/node/commit/ce986de829457c39257cd205067602e765768fb0)
153+
* For raw commit message: `git log ce986de829457c39257cd205067602e765768fb0 -1`
141154
* Collaborators are in alphabetical order by GitHub username.
142155
* Optionally, include your personal pronouns.
143156
* Label your pull request with the `doc` subsystem label.
144157
* Run CI on your PR.
145-
* After a `LGTM` or two, land the PR.
158+
* After one or two approvals, land the PR.
146159
* Be sure to add the `PR-URL: <full-pr-url>` and appropriate `Reviewed-By:` metadata!
160+
* [`core-validate-commit`][] helps a lot with this – install and use it if you can!
161+
* If you use Chrome, [`node-review`][] fetches the metadata for you
147162

148163
## Final notes
149164

150-
* don't worry about making mistakes: everybody makes them, there's a lot to internalize and that takes time (and we recognize that!)
151-
* very few (no?) mistakes are unrecoverable
152-
* the existing collaborators trust you and are grateful for your help!
153-
* other repos:
154-
* [https://github.com/nodejs/dev-policy](https://github.com/nodejs/dev-policy)
155-
* [https://github.com/nodejs/NG](https://github.com/nodejs/NG)
156-
* [https://github.com/nodejs/api](https://github.com/nodejs/api)
165+
* Don't worry about making mistakes: everybody makes them, there's a lot to internalize and that takes time (and we recognize that!)
166+
* Almost any mistake you could make can be fixed or reverted.
167+
* The existing Collaborators trust you and are grateful for your help!
168+
* Other repositories:
169+
* [https://github.com/nodejs/CTC](https://github.com/nodejs/CTC)
157170
* [https://github.com/nodejs/build](https://github.com/nodejs/build)
158-
* [https://github.com/nodejs/docs](https://github.com/nodejs/docs)
159171
* [https://github.com/nodejs/nodejs.org](https://github.com/nodejs/nodejs.org)
160172
* [https://github.com/nodejs/readable-stream](https://github.com/nodejs/readable-stream)
161173
* [https://github.com/nodejs/LTS](https://github.com/nodejs/LTS)
174+
* [https://github.com/nodejs/citgm](https://github.com/nodejs/citgm)
175+
176+
[Code of Conduct]: https://github.com/nodejs/TSC/blob/master/CODE_OF_CONDUCT.md
177+
[`core-validate-commit`]: https://github.com/evanlucas/core-validate-commit
178+
[`node-review`]: https://github.com/evanlucas/node-review

0 commit comments

Comments
 (0)