Browse Source

doc: update Reviewing section of onboarding doc

PR-URL; https://github.com/nodejs/node/pull/8086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: targos - Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: jasnell - James M Snell <jasnell@gmail.com>
v6.x
Rich Trott 9 years ago
committed by Evan Lucas
parent
commit
31653a5006
  1. 56
      doc/onboarding.md

56
doc/onboarding.md

@ -64,31 +64,37 @@ onboarding session.
* will also come more naturally over time * will also come more naturally over time
* reviewing: * Reviewing:
* primary goal is for the codebase to improve * The primary goal is for the codebase to improve.
* secondary (but not far off) is for the person submitting code to succeed * Secondary (but not far off) is for the person submitting code to succeed.
* helps grow the community A pull request from a new contributor is an opportunity to grow the
* and draws new people into the project community.
* Review a bit at a time. It is **very important** to not overwhelm newer people. * Review a bit at a time. Do not overwhelm new contributors.
* it is tempting to micro-optimize / make everything about relative perf, * It is tempting to micro-optimize and make everything about relative
don't succumb to that temptation. we change v8 a lot more often now, contortions performance. Don't succumb to that temptation. We change V8 often.
that are zippy today may be unnecessary in the future Techniques that provide improved performance today may be unnecessary in
* be aware: your opinion carries a lot of weight! the future.
* nits are fine, but try to avoid stalling the PR * Be aware: Your opinion carries a lot of weight!
* note that they are nits when you comment * Nits (requests for small changes that are not essential) are fine, but try
* if they really are stalling nits, fix them yourself on merge (but try to let PR authors know they can fix these) to avoid stalling the pull request.
* improvement doesn't have to come all at once * Note that they are nits when you comment: `Nit: change foo() to bar().`
* minimum wait for comments time * If they are stalling the pull request, fix them yourself on merge.
* There is a minimum waiting time which we try to respect for non-trivial changes, so that people who may have important input in such a distributed project are able to respond. * Minimum wait for comments time
* It may help to set time limits and expectations: * There is a minimum waiting time which we try to respect for non-trivial
* the collaborators are very distributed so it is unlikely that they will be looking at stuff the same time as you are. changes, so that people who may have important input in such a
* before merging code: give folks at least one working day to respond: "If no one objects, tomorrow at <time> I'll merge this in." distributed project are able to respond.
* please always either specify your timezone, or use UTC time * For non-trivial changes, leave the pull request open for at least 48
* set reminders hours (72 hours on a weekend).
* check in on the code every once in a while (set reminders!) * If a pull request is abandoned, check if they'd mind if you took it over
* 48 hours for non-trivial changes, and 72 hours on weekends. (especially if it just has nits left).
* if a PR is abandoned, check if they'd mind if you took it over (especially if it just has nits left) * Approving a change
* you have the power to `LGTM` another collaborator or TSC / CTC members' work * Collaborators indicate that they have reviewed and approve of the
the changes in a pull request by commenting with `LGTM`, which stands
for "looks good to me".
* You have the power to `LGTM` another collaborator's (including TSC/CTC
members) work.
* You may not `LGTM` your own pull requests.
* You have the power to `LGTM` anyone else's pull requests.
* what belongs in node: * what belongs in node:

Loading…
Cancel
Save