Repository: mesos Updated Branches: refs/heads/master f05f1b584 -> 1949d01fd
Updated patch submission document to mention small independent commits. Review: https://reviews.apache.org/r/39384 Project: http://git-wip-us.apache.org/repos/asf/mesos/repo Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/1949d01f Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/1949d01f Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/1949d01f Branch: refs/heads/master Commit: 1949d01fd75c7ebb27f18f7b618bb554d17f8aa7 Parents: f05f1b5 Author: Neil Conway <[email protected]> Authored: Mon Nov 2 10:52:41 2015 -0800 Committer: Benjamin Mahler <[email protected]> Committed: Mon Nov 2 10:54:26 2015 -0800 ---------------------------------------------------------------------- docs/submitting-a-patch.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mesos/blob/1949d01f/docs/submitting-a-patch.md ---------------------------------------------------------------------- diff --git a/docs/submitting-a-patch.md b/docs/submitting-a-patch.md index a7aee3f..f0048f5 100644 --- a/docs/submitting-a-patch.md +++ b/docs/submitting-a-patch.md @@ -46,7 +46,11 @@ layout: documentation 1. To build all tests without executing them, use something like: `make tests`. 2. To execute a single unit test (helpful when trying to debug a test case failure), use something like: `make check GTEST_FILTER="HTTPTest.Delete"`. -4. Make sure to pull in any changes that have been committed to master branch. Using Git, do this via something like: +4. Divide your change into one or more Git commits. Each commit should represent a single logical (atomic) change to the Mesos source code: this makes your changes easier to review. For more information, see the [reviewer guidelines](effective-code-reviewing.md). + 1. Try to avoid including other, unrelated cleanups (e.g., typo fixes or style nits) in the same commit that makes functional changes. While typo fixes are great, including them in the same commit as functional changes makes the commit history harder to read. + 2. Developers often make incremental commits to save their progress when working on a change, and then "rewrite history" (e.g., using `git rebase -i`) to create a clean set of commits once the change is ready to be reviewed. + +5. Make sure to pull in any changes that have been committed to master branch. Using Git, do this via something like: 1. `git checkout master` 2. `git pull` 3. `git checkout my_branch`
