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 "Avro/HowToContribute" by DougCutting
Date Fri, 10 Apr 2009 20:23:06 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 DougCutting:
http://wiki.apache.org/hadoop/Avro/HowToContribute

The comment on the change is:
remove some irrelevant bits

------------------------------------------------------------------------------
  = How to Contribute to Apache Avro =
  
- This page describes the mechanics of ''how'' to contribute software to Apache Avro.  For
ideas about ''what'' you might contribute, please see the [:Avro/ProjectSuggestions: ProjectSuggestions
page].
+ This page describes the mechanics of ''how'' to contribute software to Apache Avro.  For
ideas about ''what'' you might contribute, please look in Avro's [https://issues.apache.org/jira/browse/AVRO
Jira] database.
  
  === Getting the source code ===
  
@@ -14, +14 @@

  svn checkout http://svn.apache.org/repos/asf/hadoop/avro/trunk/ avro-trunk
  }}}
  
- You may also want to develop against a specific release.  To do so, visit [http://svn.apache.org/repos/asf/hadoop/avro/tags/]
and find the release that you are interested in developing against.  To checkout this release,
run:
- 
- {{{
- svn checkout http://svn.apache.org/repos/asf/hadoop/avro/tags/release-X.Y.Z/ avro-X.Y.Z
- }}}
- 
- If you prefer to use Eclipse for development, there are instructions for setting up SVN
access from within Eclipse at [:Avro/EclipseEnvironment: EclipseEnvironment].
- 
  === Making Changes ===
  
- Before you start, send a message to the [http://hadoop.apache.org/avro/mailing_lists.html
Avro developer mailing list], or file a bug report in [:Avro/Jira: Jira].  Describe your proposed
changes and check that they fit in with what others are doing and have planned for the project.
 Be patient, it may take folks a while to understand your requirements.
+ Before you start, send a message to the [http://hadoop.apache.org/avro/mailing_lists.html
Avro developer mailing list], or file a bug report in [https://issues.apache.org/jira/browse/AVRO
Jira].  Describe your proposed changes and check that they fit in with what others are doing
and have planned for the project.  Be patient, it may take folks a while to understand your
requirements.
  
  Modify the source code and add some (very) nice features using your favorite IDE.[[BR]]
  
@@ -37, +29 @@

   * New unit tests should be provided to demonstrate bugs and fixes.  [http://www.junit.org
JUnit] is our test framework:
    * You must implement a class that extends {{{junit.framework.TestCase}}} and whose class
name starts with {{{Test}}}.
    * Define methods within your class whose names begin with {{{test}}}, and call JUnit's
many assert methods to verify conditions; these methods will be executed when you run {{{ant
test}}}.
-   * By default, do not let tests write any temporary files to {{{/tmp}}}.  Instead, the
tests should write to the location specified by the {{{test.build.data}}} system property.
+   * By default, do not let tests write any temporary files to {{{/tmp}}}.  Instead, the
tests should write to the location specified by the {{{test.dir}}} system property.
    * Place your class in the {{{src/java/test}}} tree.
-   * {{{ClientTest.java}}} is an example of a client-server 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 -Dtestcase=<class name without package prefix> test}}}
(for example {{{ant -Dtestcase=ClientTest 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 -Dtestcase=<class name without package prefix> test}}}
(for example {{{ant -Dtestcase=TestFoo test}}})
- 
- ==== Understanding Ant ====
- 
- Avro is built by Ant, a Java building tool.  This section will eventually describe how Ant
is used within Avro.  To start, simply read a good Ant tutorial.  The following is a good
tutorial, though keep in mind that Avro isn't structured according to the ways outlined in
the tutorial.  Use the tutorial to get a basic understand of Ant but not to understand how
Ant is used for Hadoop:
- 
-  * Good Ant tutorial: http://i-proving.ca/space/Technologies/Ant+Tutorial
  
  === Generating a patch ===
  
@@ -56, +41 @@

  
  {{{
  > cd avro-trunk
- > ant -Djavac.args="-Xlint -Xmaxwarns 1000" clean test tar
+ > ant clean test
  }}}
  After a while, if you see
  {{{
@@ -74, +59 @@

  
  {{{
  > ant javadoc
- > firefox build/docs/api/index.html
+ > firefox build/doc/api/index.html
  }}}
  
  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.
@@ -119, +104 @@

   1. Submit both the shell script and the patch file.
  This way other developers can preview your change by running the script and then applying
the patch.
  
- ==== Testing your patch ====
- 
- Before submitting your patch, you are encouraged to run the same tools that the automated
Hudson system will run on your patch.  This enables you to fix problems with your patch before
you submit it.  The {{{test}}} Ant target will run your patch through the same checks that
Hudson currently does.
- 
- To use this target, you must run it from a clean workspace (ie {{{svn stat}}} shows no modifications
or additions).  From your clean workspace, run:
- 
- {{{
- ant test
- }}}
- 
- At the end, you should get a message on your console that indicates success.
- 
- Some things to note:
-  * you may need to explicitly set ANT_HOME.  Running {{{ant -diagnostics}}} will tell you
the default value on your system.
-  * you may need to explicitly set JAVA_HOME.
- 
  ==== Applying a patch ====
  
  To apply a patch either you generated or found from JIRA, you can issue 
@@ -150, +119 @@

  
  === Contributing your work ===
  
- Finally, patches should be ''attached'' to an issue report in [http://issues.apache.org/jira/browse/AVRO
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). 
+ Finally, patches should be ''attached'' to an issue report in [http://issues.apache.org/jira/browse/AVRO
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]). 
  
  When you believe that your patch is ready to be committed, select the '''Submit Patch'''
link on the issue's Jira.
  
- Folks should run {{{ant clean test javadoc}}} before selecting '''Submit Patch'''.  Tests
should all pass.  Javadoc should report '''no''' warnings or 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).
+ Folks should run {{{ant clean test javadoc}}} before selecting '''Submit Patch'''.  Tests
should all pass.  Javadoc should report '''no''' warnings or errors. Submitting patches that
fail tests 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.
  
@@ -162, +131 @@

  
  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.
  
- 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.
+ Once you have submitted your patch, a committer should 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.
+ Should your patch be rejected, select the '''Resume Progress''' on the issue's Jira, upload
a new patch with necessary fixes, and then select the '''Submit Patch''' link again.
  
- In some cases a patch may need to be updated based on review comments. In this case the
updated patch should be re-attached to the Jira with the name name. Jira will archive the
older version of the patch and make the new patch the active patch. This will enable a history
of patches on the Jira. As stated above patch naming is generally AVRO-#.patch where AVRO-#
is the id of the Jira.
+ In many cases a patch may need to be updated based on review comments. In this case the
updated patch should be re-attached to the Jira with the name name. Jira will archive the
older version of the patch and make the new patch the active patch. This will enable a history
of patches on the Jira. As stated above patch naming is generally AVRO-#.patch where AVRO-#
is the id of the Jira issue.
  
  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.
  
@@ -178, +147 @@

  
  == Jira Guidelines ==
  
- Please comment on issues in Jira, making their concerns known.  Please also vote for issues
that are a high priority for you.
+ Please comment on issues in Jira, making your concerns known.  Please also vote for issues
that are a high priority for you.
  
  Please refrain from editing descriptions and comments if possible, as edits spam the mailing
list and clutter Jira's "All" display, which is otherwise very useful.  Instead, preview descriptions
and comments using the preview button (on the right) before posting them.  Keep descriptions
brief and save more elaborate proposals for comments, since descriptions are included in Jira's
automatically sent messages.  If you change your mind, note this in a new comment, rather
than editing an older comment.  The issue should preserve this history of the discussion.
  

Mime
View raw message