hadoop-common-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Hadoop Wiki] Update of "HowToContribute" by ArpitAgarwal
Date Tue, 03 Jun 2014 22:45:45 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Hadoop Wiki" for change notification.

The "HowToContribute" page has been changed by ArpitAgarwal:
https://wiki.apache.org/hadoop/HowToContribute?action=diff&rev1=90&rev2=91

Comment:
Update patch instructions, add suggestion for target branch selection

  
  
  === Generating a patch ===
+ ==== Choosing a target branch ====
+ Except for the following situations it is recommended that all patches be based off trunk
to take advantage of the Jenkins pre-commit build.
+  1. The patch is targeting a release branch that is not based off trunk e.g. branch-1, branch-0.23
etc.
+  1. The change is targeting a specific feature branch and is not yet ready for merging into
trunk.
+ 
+ If you are unsure of the target branch then '''trunk''' is usually the best choice. Committers
will usually merge the patch to downstream branches e.g. branch-2 as appropriate.
+ 
  ==== Unit Tests ====
  Please make sure that all unit tests succeed before constructing your patch and that no
new javac compiler warnings are introduced by your patch.
  
@@ -222, +229 @@

  
  Patches for trunk should be named according to the Jira: '''jira-xyz.patch''', eg hdfs-1234.patch.
  
- Patches for a non-trunk branch should be named '''jira-xyz-branch.patch''', eg hdfs-123-branch-0.20-security.patch.
 The branch name suffix should be the exact name of a Subversion branch under hadoop/common/branches/,
such as "branch-0.20-security".  This naming convention allows the pre-commit tests to automatically
run against the correct branch (new capability coming soon; see HADOOP-7435).
+ Patches for a non-trunk branch should be named '''jira-xyz-branch.patch''', eg hdfs-123-branch-2.patch.
 The branch name suffix should be the exact name of a Subversion branch under hadoop/common/branches/,
such as "branch-0.20-security". Please note that the Jenkins pre-commit build is only run
against trunk.
  
- It's OK to upload a new patch to Jira with the same name as an existing patch, Jira will
just make the previous patches grey. They're still listed, sorted by date. If you select the
"Activity>All" tab then the different versions are linked in the comment stream, providing
context.
+ It's OK to upload a new patch to Jira with the same name as an existing patch. If you select
the "Activity>All" tab then the different versions are linked in the comment stream, providing
context. However many contributors find it convenient to add a numeric suffix to the patch
indicating the patch revision. e.g. hdfs-1234.01.patch, hdfs-1234.02.patch etc.
  
  
  ==== Testing your patch ====
@@ -241, +248 @@

  Some things to note:
  
   * the optional cmd parameters will default to the ones in your {{{PATH}}} environment variable
-  * the {{{grep}}} command must support the -o flag (GNU does)
+  * the {{{grep}}} command must support the -o flag (Both GNU grep bundled and BSD grep do
so)
   * the {{{patch}}} command must support the -E flag
  
  Run the same command with no arguments to see the usage options.

Mime
View raw message