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 NigelDaley
Date Thu, 03 Apr 2008 00:51:01 GMT
Dear Wiki user,

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

The following page has been changed by NigelDaley:
http://wiki.apache.org/hadoop/HowToContribute

The comment on the change is:
Fix nits and add info for new Jira fields: Incompatible, Reviewed, Release Note

------------------------------------------------------------------------------
    * Place your class in the {{{src/test}}} tree.
    * {{{TestFileSystem.java}}} and {{{TestMapRed.java}}} are examples of standalone MapReduce-based
tests.
    * {{{TestPath.java}}} is an example of a non MapReduce-based test.
-   * you can run all the unit test with the command {{{ant test}}}, or you can run a specific
unit test with the command {{{ant test -Dtestcase=<ClassName>}}} (For example {{{ant
test -Dtestcase=TestFileSystem}}})
+   * You can run all the unit test with the command {{{ant test}}}, or you can run a specific
unit test with the command {{{ant -Dtestcase=<class name without package prefix> test}}}
(for example {{{ant -Dtestcase=TestFileSystem test}}})
  
  === Generating a patch ===
  
@@ -45, +45 @@

  Please make sure that all unit tests succeed before constructing your patch and that no
new javac compiler warnings are introduced by your patch.
  
  {{{
- > cd hadoop-trunk
+ > cd hadoop-core-trunk
  > ant -Djavac.args="-Xlint -Xmaxwarns 1000" clean test tar
  }}}
  After a while, if you see
@@ -67, +67 @@

  > firefox build/docs/api/index.html
  }}}
  
- Examine all public classes you've changed to see that documentation is complete and informative.
 Your patch must not generate any javadoc warnings.
+ Examine all public classes you've changed to see that documentation is complete, informative,
and properly formatted.  Your patch must not generate any javadoc warnings.
  
  ==== Creating a patch ====
  Check to see what files you have modified with:
@@ -78, +78 @@

  Add any new files with:
  {{{
  svn add src/.../MyNewClass.java
+ svn add src/.../TestMyNewClass.java
  }}}
  
  Edit the ''CHANGES.txt'' file, adding a description of your change, including the bug number
it fixes. If this is a new feature, or other enhancement that doesn't currently have a ticket
please create one for it, then use it's number when adding your note to CHANGES.txt. You'll
need this ticket to submit your patch anyway.
  
- In order to create a patch, just type:
+ In order to create a patch, type:
  
  {{{
  svn diff > myBeautifulPatch.patch
@@ -142, +143 @@

  
  === Contributing your work ===
  
- Finally, patches should be ''attached'' to a bug report in [http://issues.apache.org/jira/browse/HADOOP
Jira] via the '''Attach File''' link on the jira. Please add a comment that asks for a code
review following our [:CodeReviewChecklist: code review checklist]. Please note that the attachment
should be granted license to ASF for inclusion in ASF works (as per the [http://www.apache.org/licenses/LICENSE-2.0
Apache License] §5). 
+ Finally, patches should be ''attached'' to an issue report in [http://issues.apache.org/jira/browse/HADOOP
Jira] via the '''Attach File''' link on the issue's Jira. Please add a comment that asks for
a code review following our [:CodeReviewChecklist: code review checklist]. Please note that
the attachment should be granted license to ASF for inclusion in ASF works (as per the [http://www.apache.org/licenses/LICENSE-2.0
Apache License] §5). 
  
- When you believe that your patch is ready to be committed, select the 'Submit Patch' link
from the 'Available Workflow Actions' section in Jira.  Submitted patches will be automatically
tested against "trunk" by [http://hudson.zones.apache.org/hudson/ Hudson], the project's continuous
integration engine.  Upon test completion, Hudson will add a success ("+1") message or failure
("-1") to your bug report in Jira.  If your issue contains multiple patch versions, Hudson
tests the last patch uploaded.
+ When you believe that your patch is ready to be committed, select the '''Submit Patch'''
link on the issue's Jira.  Submitted patches will be automatically tested against "trunk"
by [http://hudson.zones.apache.org/hudson/ Hudson], the project's continuous integration engine.
 Upon test completion, Hudson will add a success ("+1") message or failure ("-1") to your
issue report in Jira.  If your issue contains multiple patch versions, Hudson tests the last
patch uploaded.
  
- Folks should run 'ant clean test javadoc checkstyle' before selecting 'Submit Patch'.  Tests
should all pass.  Javadoc should report no warnings or errors. Checkstyle's error count should
not exceed that listed at [http://hudson.zones.apache.org/hudson/job/Hadoop-trunk/lastSuccessfulBuild/artifact/trunk/build/test/checkstyle-errors.html
Checkstyle Errors]  Hudson's tests should only double-check things, and not be used as a primary
patch tester, which would create too much noise on the mailing list and in Jira.  Submitting
patches that fail Hudson testing is frowned on, (unless the failure is not actually due to
the patch).
+ Folks should run {{{ant clean test javadoc checkstyle}}} before selecting '''Submit Patch'''.
 Tests should all pass.  Javadoc should report '''no''' warnings or errors. Checkstyle's error
count should not exceed that listed at [http://hudson.zones.apache.org/hudson/job/Hadoop-trunk/lastSuccessfulBuild/artifact/trunk/build/test/checkstyle-errors.html
Checkstyle Errors]  Hudson's tests are meant to double-check things, and not be used as a
primary patch tester, which would create too much noise on the mailing list and in Jira. 
Submitting patches that fail Hudson testing is frowned on, (unless the failure is not actually
due to the patch).
  
  If your patch involves performance optimizations, they should be validated by benchmarks
that demonstrate an improvement.
  
- Once a "+1" comment is received from the automated patch testing system and a "+1, code
reviewed" comment is received from a code reviewer, a committer should then evaluate it within
a few days and either: commit it; or reject it with an explanation.
+ If your patch creates an incompatibility with the latest major release, then you must set
the '''Incompatible change''' flag on the issue's Jira 'and' fill in the '''Release Note'''
field with an explanation of the impact of the incompatibility and the necessary steps users
must take.
  
- Please be patient.  Committers are busy people too.  If no one responds to your patch after
a few days, please make friendly reminders.  Please incorporate other's suggestions into into
your patch if you think they're reasonable.  Finally, remember that even a patch that is not
committed is useful to the community.
+ If your patch implements a major feature or improvement, then you must fill in the '''Release
Note''' field on the issue's Jira with an explanation of the feature that will be comprehensible
by the end user.
  
- Should your patch earn a -1 on the Hudson test, set the issue status to 'Resume Progress',
upload a patch with necessary fixes and then set the status to 'Submit Patch' again.
+ Once a "+1" comment is received from the automated patch testing system and a code reviewer
has set the '''Reviewed''' flag on the issue's Jira, a committer should then evaluate it within
a few days and either: commit it; or reject it with an explanation.
  
+ Please be patient.  Committers are busy people too.  If no one responds to your patch after
a few days, please make friendly reminders.  Please incorporate other's suggestions into your
patch if you think they're reasonable.  Finally, remember that even a patch that is not committed
is useful to the community.
+ 
+ Should your patch receive a "-1" from the Hudson testing, select the '''Resume Progress'''
on the issue's Jira, upload a new patch with necessary fixes, and then select the '''Submit
Patch''' link again.
+ 
- Committers: for non-trivial changes, it is best to get another committer to review your
patches before commit.  Use "Submit Patch" like other contributors, and then wait for a "+1"
from another committer before committing.  Please also try to frequently review things in
the patch queue.
+ Committers: for non-trivial changes, it is best to get another committer to review your
patches before commit.  Use '''Submit Patch''' link like other contributors, and then wait
for a "+1" from another committer before committing.  Please also try to frequently review
things in the patch queue.
  
  == Jira Guidelines ==
  

Mime
View raw message