You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-commits@hadoop.apache.org by Apache Wiki <wi...@apache.org> on 2016/06/17 06:28:10 UTC

[Hadoop Wiki] Update of "HowToContribute" by AkiraAjisaka

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 AkiraAjisaka:
https://wiki.apache.org/hadoop/HowToContribute?action=diff&rev1=114&rev2=115

Comment:
Added how to use pull request.

  = How to Contribute to Hadoop =
  This page describes the mechanics of ''how'' to contribute software to Apache Hadoop.  For ideas about ''what'' you might contribute, please see the ProjectSuggestions page.
  
- <<TableOfContents(4)>>
+ <<TableOfContents(5)>>
  
  == Dev Environment Setup ==
  Here are some things you will need to build and test Hadoop. Be prepared to invest some time to set up a working Hadoop dev environment. Try getting the project to build and test locally first before  you start writing code.
@@ -113, +113 @@

  
  If Jenkins rejects a patch due to Java 8 javadoc failures, it is considered an automatic veto for the patch.
  
+ === Provide a patch ===
+ 
+ There are two patterns to provide a patch.
+  * Create and attach a diff in ASF JIRA
+  * Create a pull request in GitHub
+ 
  ==== Creating a patch ====
+ 
  Check to see what files you have modified with:
  
  {{{
@@ -154, +161 @@

  
  This way other developers can preview your change by running the script and then applying the patch.
  
- ==== Naming your patch ====
+ ===== Naming your patch =====
  
  Patches for trunk should be named according to the Jira, with a version number: '''<jiraName>.<versionNum>.patch''', e.g. HADOOP-1234.001.patch, HDFS-4321.002.patch.
  
@@ -165, +172 @@

  It's also 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 reviewers find it helpful to include a version number in the patch name (three-digit version number is recommended), '''so including a version number is the preferred style'''.
  
  NOTE: Our Jenkins configuration uses [[https://yetus.apache.org|Apache Yetus]].  More advanced patch file names are documented on their [[https://yetus.apache.org/documentation/in-progress/precommit-patchnames/|patch names page]].
+ 
+ ==== Creating a GitHub pull request ====
+ 
+ Create a pull request in https://github.com/apache/hadoop.
+ 
+ You need to set the title which starts with the corresponding JIRA issue number. (e.g. HADOOP-XXXXX. Fix a typo in YYY.)
+ Jenkins precommit job will search the corresponding GitHub pull request and apply the diff automatically.
+ If there is a corresponding pull request, you don't need to attach a patch in this issue because the precommit job always runs on pull request instead of the attached patch.
+ 
+ If there is no corresponding issue, please create a issue in ASF JIRA before creating a pull request.
  
  === Testing your patch ===
  Before submitting your patch, you are encouraged to run the same tools that the automated Jenkins patch test system will run on your patch.  This enables you to fix problems with your patch before you submit it. The {{{dev-support/bin/test-patch}}} script in the trunk directory will run your patch through the same checks that Jenkins currently does ''except'' for executing the unit tests. (See TestPatchTips for some tricks.)

---------------------------------------------------------------------
To unsubscribe, e-mail: common-commits-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-commits-help@hadoop.apache.org