Browse code

Define 'logical unit of work'

Signed-off-by: Arnaud Porterie <arnaud.porterie@docker.com>

Arnaud Porterie authored on 2015/03/17 01:30:32
Showing 1 changed files
... ...
@@ -217,10 +217,18 @@ mixed into the PR.
217 217
 feature branch to update your pull request rather than `merge master`.
218 218
 
219 219
 Before you make a pull request, squash your commits into logical units of work
220
-using `git rebase -i` and `git push -f`. After every commit, [make sure the test
221
-suite passes]((https://docs.docker.com/project/test-and-docs/)). Include
222
-documentation changes in the same pull request so that a revert would remove all
223
-traces of the feature or fix.
220
+using `git rebase -i` and `git push -f`. A logical unit of work is a consistent
221
+set of patches that should be reviewed together: for example, upgrading the
222
+version of a vendored dependency and taking advantage of its now available new
223
+feature constitute two separate units of work. Implementing a new function and
224
+calling it in another file constitute a single logical unit of work. The very
225
+high majory of submissions should have a single commit, so if in doubt: squash
226
+down to one.
227
+
228
+After every commit, [make sure the test suite passes]
229
+((https://docs.docker.com/project/test-and-docs/)). Include documentation
230
+changes in the same pull request so that a revert would remove all traces of
231
+the feature or fix.
224 232
 
225 233
 Include an issue reference like `Closes #XXXX` or `Fixes #XXXX` in commits that
226 234
 close an issue. Including references automatically closes the issue on a merge.