From 86805598f20b0705cafa6aef680befd97496059c Mon Sep 17 00:00:00 2001 From: Doug Meil Date: Tue, 30 Aug 2011 21:03:11 +0000 Subject: [PATCH] HBASE-4305 developer.xml git-svn-id: https://svn.apache.org/repos/asf/hbase/trunk@1163382 13f79535-47bb-0310-9956-ffa450edef68 --- src/docbkx/developer.xml | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/src/docbkx/developer.xml b/src/docbkx/developer.xml index 42dbac5dd66..70c40f8e9be 100644 --- a/src/docbkx/developer.xml +++ b/src/docbkx/developer.xml @@ -183,6 +183,7 @@ mvn test -Dtest=TestXYZ
Create Patch Patch files can be easily generated from Eclipse, for example by selecting "Team -> Create Patch". + Patches can also be created by git diff and svn diff. Please submit one patch-file per Jira. For example, if multiple files are changed make sure the selected resource when generating the patch is a directory. Patch files can reflect changes in multiple files. @@ -191,13 +192,16 @@ mvn test -Dtest=TestXYZ
Patch File Naming The patch file should have the HBase Jira ticket in the name. For example, if a patch was submitted for Foo.java, then - a patch file called Foo_HBASE_XXX.patch would be acceptable where XXX is the HBase Jira number. + a patch file called Foo_HBASE_XXXX.patch would be acceptable where XXXX is the HBase Jira number. + + If you generating from a branch, then including the target branch in the filename is advised, e.g., HBASE-XXXX-0.90.patch.
Unit Tests - Yes, please. Please try to include unit tests with every code patch (and especially new classes and large changes). - Also, please make sure unit tests pass locally before submitting the patch. + Yes, please. Please try to include unit tests with every code patch (and especially new classes and large changes). + Make sure unit tests pass locally before submitting the patch. + Also, see .
Attach Patch to Jira @@ -312,11 +316,13 @@ Bar bar = foo.getBar(); <--- imagine there's an extra space(s) after the But the preference is to add something descriptive and useful.
-
- Unrelated Code Formating or Auto-Reformating +
+ One Thing At A Time, Folks If you submit a patch for one thing, don't do auto-reformatting or unrelated reformatting of code on a completely different area of code. + Likewise, don't add unrelated cleanup or refactorings outside the scope of your Jira. +
Ambigious Unit Tests