]> review.fuel-infra Code Review - openstack-build/neutron-build.git/commitdiff
Clarify with example mentioning gratuitous whitespace changes
authorCarl Baldwin <carl.baldwin@hpe.com>
Fri, 23 Oct 2015 21:04:39 +0000 (21:04 +0000)
committerCarl Baldwin <carl@ecbaldwin.net>
Thu, 29 Oct 2015 20:51:37 +0000 (20:51 +0000)
Maybe I'm just too picky but I usually call this stuff out in reviews
even if I decide to +2 the patch set.

Change-Id: I5a2667d44203147e112f5a1d7573105478d805f7

doc/source/devref/effective_neutron.rst

index 053d2712ce269e05d43791bb42e7dde8f4cf66b7..01ebd16316a07e42d9843035516c2f0cb58c8734 100644 (file)
@@ -230,7 +230,9 @@ Scoping your patch appropriately
 * Do not make multiple changes in one patch unless absolutely necessary.
   Cleaning up nearby functions or fixing a small bug you noticed while working
   on something else makes the patch very difficult to review. It also makes
-  cherry-picking and reverting very difficult.
+  cherry-picking and reverting very difficult.  Even apparently minor changes
+  such as reformatting whitespace around your change can burden reviewers and
+  cause merge conflicts.
 * If a fix or feature requires code refactoring, submit the refactoring as a
   separate patch than the one that changes the logic. Otherwise
   it's difficult for a reviewer to tell the difference between mistakes