From 9438dc84bc944f1e2ca20436118d60525b60c60f Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 12 Mar 2018 22:03:19 -0700 Subject: [PATCH] doc: improve best practices in onboarding-extras --- doc/onboarding-extras.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/doc/onboarding-extras.md b/doc/onboarding-extras.md index 1a39b5acaed1a0..2bbf2957835295 100644 --- a/doc/onboarding-extras.md +++ b/doc/onboarding-extras.md @@ -142,10 +142,7 @@ to update from nodejs/node: * `git remote update -p` OR `git fetch --all` (I prefer the former) * `git merge --ff-only upstream/master` (or `REMOTENAME/BRANCH`) -## best practices +## Best practices -* commit often, out to your github fork (origin), open a PR -* when making PRs make sure to spend time on the description: - * every moment you spend writing a good description quarters the amount of - time it takes to understand your code. -* usually prefer to only squash at the *end* of your work, depends on the change +* When making PRs, spend time writing a thorough description. +* Usually only squash at the end of your work.