Commit d6c2e38
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,23 +1,20 @@ | |||
| 1 | - ## pre-setup | ||
| 1 | + # Onboarding | ||
| 2 | 2 | ||
| 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. | ||
| 4 | 5 | ||
| 6 | + * Prior to the onboarding session, add the new Collaborators to | ||
| 7 | + [the Collaborators team](https://github.com/orgs/nodejs/teams/collaborators). | ||
| 5 | 8 | ||
| 6 | - ## onboarding to nodejs | ||
| 7 | - | ||
| 8 | - ### intros | ||
| 9 | - | ||
| 10 | - | ||
| 11 | - ### **thank you** for doing this | ||
| 9 | + ## **thank you** for doing this | ||
| 12 | 10 | ||
| 13 | 11 | * going to cover four things: | |
| 14 | 12 | * local setup | |
| 15 | 13 | * some project goals & values | |
| 16 | 14 | * issues, labels, and reviewing code | |
| 17 | 15 | * merging code | |
| 18 | 16 | ||
| 19 | - | ||
| 20 | - ### setup: | ||
| 17 | + ## setup | ||
| 21 | 18 | ||
| 22 | 19 | * notifications setup | |
| 23 | 20 | * 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 | |||
| 34 | 31 | * `#node-dev` on `chat.freenode.net` is the best place to interact with the CTC / other collaborators | |
| 35 | 32 | ||
| 36 | 33 | ||
| 37 | - ### a little deeper about the project | ||
| 34 | + ## a little deeper about the project | ||
| 38 | 35 | ||
| 39 | 36 | * collaborators are effectively part owners | |
| 40 | 37 | * the project has the goals of its contributors | |
@@ -46,7 +43,7 @@ Ensure everyone is added to https://github.com/orgs/nodejs/teams/collaborators | |||
| 46 | 43 | * generally: try to be nice to people | |
| 47 | 44 | ||
| 48 | 45 | ||
| 49 | - ### managing the issue tracker | ||
| 46 | + ## managing the issue tracker | ||
| 50 | 47 | ||
| 51 | 48 | * you have (mostly) free rein – don't hesitate to close an issue if you are confident that it should be closed | |
| 52 | 49 | * this will come more naturally over time | |
@@ -113,7 +110,7 @@ Ensure everyone is added to https://github.com/orgs/nodejs/teams/collaborators | |||
| 113 | 110 | * 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. | |
| 114 | 111 | ||
| 115 | 112 | ||
| 116 | - ### process for getting code in: | ||
| 113 | + ## process for getting code in | ||
| 117 | 114 | ||
| 118 | 115 | * the collaborator guide is a great resource: https://github.com/nodejs/node/blob/master/COLLABORATOR_GUIDE.md#technical-howto | |
| 119 | 116 | ||
@@ -145,7 +142,7 @@ Ensure everyone is added to https://github.com/orgs/nodejs/teams/collaborators | |||
| 145 | 142 | * Info on PRs that don't like to apply found under [**"If `git am` fails"**](./onboarding-extras.md#if-git-am-fails). | |
| 146 | 143 | ||
| 147 | 144 | ||
| 148 | - ### Landing PRs | ||
| 145 | + ## Landing PRs | ||
| 149 | 146 | ||
| 150 | 147 | * Please never use GitHub's green "Merge Pull Request" button. | |
| 151 | 148 | * If you do, please force-push removing the merge. | |
@@ -173,7 +170,7 @@ Landing a PR | |||
| 173 | 170 | * close the original PR with "Landed in `<commit hash>`". | |
| 174 | 171 | ||
| 175 | 172 | ||
| 176 | - ### exercise: make PRs adding yourselves to the README. | ||
| 173 | + ## exercise: make PRs adding yourselves to the README | ||
| 177 | 174 | ||
| 178 | 175 | * Example: https://github.com/nodejs/node/commit/7b09aade8468e1c930f36b9c81e6ac2ed5bc8732 | |
| 179 | 176 | * to see full URL: `git log 7b09aade8468e1c930f36b9c81e6ac2ed5bc8732 -1` | |
@@ -183,7 +180,7 @@ Landing a PR | |||
| 183 | 180 | * Make sure to added the `PR-URL: <full-pr-url>`! | |
| 184 | 181 | ||
| 185 | 182 | ||
| 186 | - ### final notes: | ||
| 183 | + ## final notes | ||
| 187 | 184 | ||
| 188 | 185 | * don't worry about making mistakes: everybody makes them, there's a lot to internalize and that takes time (and we recognize that!) | |
| 189 | 186 | * very few (no?) mistakes are unrecoverable | |
0 commit comments