doc: add onboarding documentation #3726
Conversation
|
sounds like a great idea... let me know if you need any support |
| * lib/crypto,tls,https: indutny, shigeki | ||
| * src/node_crypto.*: indutny, shigeki | ||
| * lib/timers: fishrock123 | ||
| * upgrading v8: bnoordhuis / targos / ofrobots |
There was a problem hiding this comment.
todo: update this list even more. Maybe move to the wiki?
There was a problem hiding this comment.
Any C++ changes: indutny, bnoordhuis, trevnorris
There was a problem hiding this comment.
Also, the names are seperated by , everywhere.
There was a problem hiding this comment.
hmm... I've been thinking more and more that these should be teams like nodejs/http as opposed to specific individuals. For one, it makes it easier to remember and easier to mention multiple people.
PR_URL: #3724 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Myles Borins <mborins@us.ibm.com>
|
Isn't a good chunk of this information already available in either the collaborator guide or the contributing guide? |
|
@mscdex possibly, but it should be consolidated then |
|
I'm not sure how much consolidation could/should be done really, since a lot of the technical stuff would be useful to non-collaborators submitting PRs and the like. |
| ### a little deeper about the project | ||
| * effectively has the goals of it's contributors | ||
| * but, there are some higher-level goals and values | ||
| * not everything belongs in core (if it can be done reasonably in userland, let is stay in userland) |
|
One thing to keep in mind is that this is an overview of how to perform common operations, who to talk to for problems, and where to get questions answered. It may duplicate information found elsewhere, and that is totally fine — no need to consolidate. It would be best to keep this to three sections with an introduction and closing. Roughly, we should cover "Setup", "Interacting on the Issue Tracker", and "Merging Code." Most of the folks I've given this to already have an understanding of project layout, so I've found it's the part I gloss over the most. The goal is that folks exit this onboarding with an internal model of the values the project has to aid them in making decisions, and an idea of who to ask (or where to look) if they have questions — in other words, we are making sure that they feel that they have our full support. We add a separate document to this PR that covers how to run an onboarding session, since that doesn't really have any physical documentation at this point. Also 👏 @Fishrock123 for PR'ing this in! |
|
This should help lots with helping new contributors to get comfortable with helping out. 😄 |
|
@Fishrock123 ... In your comment, you indicate additional pieces that need working out.. including: What specific actions do we need here? |
|
@jasnell I think we need to sort this out between the collaborator guide and the contributing doc. Collaborator guide should be an extension of the contributing doc and should be : how to deal with issues, who to cc, signing off, technical info for merging commits, running the ci, etc. Contributing doc should absorb the top-level goals, etiquette, basic contributing technical info, etc. If no-one else wants to take it up I can but I probably won't get to it until at least wednesday. |
|
addressed nits, added more ci info, and attempting to make proper links for the section call-outs |
Fishrock123
force-pushed
the
onboarding-docs
branch
from
d39f423 to
982768c
Compare
PR-URL: nodejs#3726 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
Fishrock123
force-pushed
the
onboarding-docs
branch
from
982768c to
7a3ed98
Compare
PR-URL: #3726 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
PR-URL: #3726 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
PR-URL: #3726 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
PR-URL: #3726 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
cc @chrisdickinson
This is probably somewhat outdated, in slight disarray and in need of more work and review generally.
Figure it'l at least do better as a PR rather than sitting in chirs's or my gist.