Merge pull request #12047 from thockin/devdocs

Add a note on when to use commits
kubernetes · Jul 31, 2015 · a101aa1 · a101aa1
2 parents 853ea5b + c58e3fb
commit a101aa1
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/docs/devel/development.md b/docs/devel/development.md
@@ -99,6 +99,17 @@ git push -f origin myfeature
 1. Visit http://github.com/$YOUR_GITHUB_USERNAME/kubernetes
 2. Click the "Compare and pull request" button next to your "myfeature" branch.
 
+### When to retain commits and when to squash
+
+Upon merge, all git commits should represent meaningful milestones or units of
+work.  Use commits to add clarity to the development and review process.
+
+Before merging a PR, squash any "fix review feedback", "typo", and "rebased"
+sorts of commits.  It is not imperative that every commit in a PR compile and
+pass tests independently, but it is worth striving for.  For mass automated
+fixups (e.g. automated doc formatting), use one or more commits for the
+changes to tooling and a final commit to apply the fixup en masse.  This makes
+reviews much easier.
 
 ## godep and dependency management