From aad7fbe6cd4e5e899fc4badfa7fe0264fe35c443 Mon Sep 17 00:00:00 2001 From: Misty Stanley-Jones Date: Mon, 10 Aug 2015 11:59:09 +1000 Subject: [PATCH] HBASE-12256 Update patch submission guidelines to call out binary file support --- src/main/asciidoc/_chapters/developer.adoc | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/src/main/asciidoc/_chapters/developer.adoc b/src/main/asciidoc/_chapters/developer.adoc index ef602ea4020..51847673b6c 100644 --- a/src/main/asciidoc/_chapters/developer.adoc +++ b/src/main/asciidoc/_chapters/developer.adoc @@ -1689,7 +1689,9 @@ $ make_patch.sh [-a] [-p ] If you decline, the script uses +git diff+ instead. The patch is saved in a configurable directory and is ready to be attached to your JIRA. -* .Patching WorkflowAlways patch against the master branch first, even if you want to patch in another branch. +.Patching Workflow + +* Always patch against the master branch first, even if you want to patch in another branch. HBase committers always apply patches first to the master branch, and backport if necessary. * Submit one single patch for a fix. If necessary, squash local commits to merge local commits into a single one first. @@ -1725,17 +1727,20 @@ Please understand that not every patch may get committed, and that feedback will However, at times it is easier to refer to different version of a patch if you add `-vX`, where the [replaceable]_X_ is the version (starting with 2). * If you need to submit your patch against multiple branches, rather than just master, name each version of the patch with the branch it is for, following the naming conventions in <>. -.Methods to Create PatchesEclipse:: +.Methods to Create Patches +Eclipse:: Select the menu item. Git:: - `git format-patch` is preferred because it preserves commit messages. + `git format-patch` is preferred: + - It preserves the committer and commit message. + - It handles binary files by default, whereas `git diff` ignores them unless + you use the `--binary` option. Use `git rebase -i` first, to combine (squash) smaller commits into a single larger one. Subversion:: - -Make sure you review <> and <> for code style. -If your patch was generated incorrectly or your code does not adhere to the code formatting guidelines, you may be asked to redo some work. + Make sure you review <> and <> for code style. + If your patch was generated incorrectly or your code does not adhere to the code formatting guidelines, you may be asked to redo some work. [[submitting.patches.tests]] ==== Unit Tests