Skip to content

Commit d6c2e38

Browse files
TrottMylesBorins
authored andcommitted
doc: minor updates to onboarding doc
PR-URL: #8060 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Franziska Hinkelmann <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent e46d1e0 commit d6c2e38

File tree

1 file changed

+13
-16
lines changed

1 file changed

+13
-16
lines changed

doc/onboarding.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,20 @@
1-
## pre-setup
1+
# Onboarding
22

3-
Ensure everyone is added to https://github.com/orgs/nodejs/teams/collaborators
3+
This document is an outline of the things we tell new Collaborators at their
4+
onboarding session.
45

6+
* Prior to the onboarding session, add the new Collaborators to
7+
[the Collaborators team](https://github.com/orgs/nodejs/teams/collaborators).
58

6-
## onboarding to nodejs
7-
8-
### intros
9-
10-
11-
### **thank you** for doing this
9+
## **thank you** for doing this
1210

1311
* going to cover four things:
1412
* local setup
1513
* some project goals & values
1614
* issues, labels, and reviewing code
1715
* merging code
1816

19-
20-
### setup:
17+
## setup
2118

2219
* notifications setup
2320
* use https://github.com/notifications or set up email
@@ -34,7 +31,7 @@ Ensure everyone is added to https://github.com/orgs/nodejs/teams/collaborators
3431
* `#node-dev` on `chat.freenode.net` is the best place to interact with the CTC / other collaborators
3532

3633

37-
### a little deeper about the project
34+
## a little deeper about the project
3835

3936
* collaborators are effectively part owners
4037
* the project has the goals of its contributors
@@ -46,7 +43,7 @@ Ensure everyone is added to https://github.com/orgs/nodejs/teams/collaborators
4643
* generally: try to be nice to people
4744

4845

49-
### managing the issue tracker
46+
## managing the issue tracker
5047

5148
* you have (mostly) free rein – don't hesitate to close an issue if you are confident that it should be closed
5249
* this will come more naturally over time
@@ -113,7 +110,7 @@ Ensure everyone is added to https://github.com/orgs/nodejs/teams/collaborators
113110
* The remaining elements on the form are typically unchanged with the exception of `POST_STATUS_TO_PR`. Check that if you want a CI status indicator to be automatically inserted into the PR.
114111

115112

116-
### process for getting code in:
113+
## process for getting code in
117114

118115
* the collaborator guide is a great resource: https://github.com/nodejs/node/blob/master/COLLABORATOR_GUIDE.md#technical-howto
119116

@@ -145,7 +142,7 @@ Ensure everyone is added to https://github.com/orgs/nodejs/teams/collaborators
145142
* Info on PRs that don't like to apply found under [**"If `git am` fails"**](./onboarding-extras.md#if-git-am-fails).
146143

147144

148-
### Landing PRs
145+
## Landing PRs
149146

150147
* Please never use GitHub's green "Merge Pull Request" button.
151148
* If you do, please force-push removing the merge.
@@ -173,7 +170,7 @@ Landing a PR
173170
* close the original PR with "Landed in `<commit hash>`".
174171

175172

176-
### exercise: make PRs adding yourselves to the README.
173+
## exercise: make PRs adding yourselves to the README
177174

178175
* Example: https://github.com/nodejs/node/commit/7b09aade8468e1c930f36b9c81e6ac2ed5bc8732
179176
* to see full URL: `git log 7b09aade8468e1c930f36b9c81e6ac2ed5bc8732 -1`
@@ -183,7 +180,7 @@ Landing a PR
183180
* Make sure to added the `PR-URL: <full-pr-url>`!
184181

185182

186-
### final notes:
183+
## final notes
187184

188185
* don't worry about making mistakes: everybody makes them, there's a lot to internalize and that takes time (and we recognize that!)
189186
* very few (no?) mistakes are unrecoverable

0 commit comments

Comments
 (0)