Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: minor updates to onboarding doc #8060

Closed
wants to merge 3 commits into from
Closed

doc: minor updates to onboarding doc #8060

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
346b964
doc: minor updates to onboarding doc
Trott Aug 10, 2016
3f17c9f
squash: typo fix
Trott Aug 10, 2016
981270f
squash: remove colons from headers
Trott Aug 11, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 13 additions & 16 deletions doc/onboarding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,20 @@
## pre-setup
# Onboarding

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

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

## onboarding to nodejs

### intros


### **thank you** for doing this
## **thank you** for doing this
Copy link
Member

@jasnell jasnell Aug 11, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

aaahhhh! lower cased headings.... must ... resist ...


* going to cover four things:
* local setup
* some project goals & values
* issues, labels, and reviewing code
* merging code


### setup:
## setup

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


### a little deeper about the project
## a little deeper about the project

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


### managing the issue tracker
## managing the issue tracker

* you have (mostly) free rein – don't hesitate to close an issue if you are confident that it should be closed
* this will come more naturally over time
Expand Down Expand Up @@ -113,7 +110,7 @@ Ensure everyone is added to https://github.com/orgs/nodejs/teams/collaborators
* 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.


### process for getting code in:
## process for getting code in

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

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


### Landing PRs
## Landing PRs

* Please never use GitHub's green "Merge Pull Request" button.
* If you do, please force-push removing the merge.
Expand Down Expand Up @@ -174,7 +171,7 @@ Landing a PR
* close the original PR with "Landed in `<commit hash>`".


### exercise: make PRs adding yourselves to the README.
## exercise: make PRs adding yourselves to the README

* Example: https://github.com/nodejs/node/commit/7b09aade8468e1c930f36b9c81e6ac2ed5bc8732
* to see full URL: `git log 7b09aade8468e1c930f36b9c81e6ac2ed5bc8732 -1`
Expand All @@ -184,7 +181,7 @@ Landing a PR
* Make sure to added the `PR-URL: <full-pr-url>`!


### final notes:
## final notes

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