pig-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Pig Wiki] Update of "HowToCommit" by AlanGates
Date Wed, 07 Nov 2007 21:30:01 GMT
Dear Wiki user,

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

The following page has been changed by AlanGates:

New page:
= Guide for Pig Committers =

This page contains Pig-specific guidelines for committers.

== New committers ==

New committers are encouraged to first read Apache's generic 
committer documentation:

    * [http://www.apache.org/dev/new-committers-guide.html Apache New Committer Guide]
    * [http://www.apache.org/dev/committers.html Apache Committer FAQ]

##The first act of a new committer is typically to add their name to the 
##[WWW] credits page. This requires changing the XML source in 
##src/docs/src/documentation/content/xdocs/credits.xml, running 
##forrest to regenerate the site(cd src/docs/ ; forrest site), manually 
##copying the modified pages to docs/ (cp build/site/credits.* 
##../../docs/), committing these changes, and finally, on 
##people.apache.org, running 'cd /www/lucene.apache.org/hadoop; 
##svn up'.

== Review ==

Hadoop committers should, as often as possible, attempt to review 
patches submitted by others. Ideally every submitted patch will get 
reviewed by a committer within a few days. If a committer reviews a 
patch they've not authored, and believe it to be of sufficient quality, 
then they can commit the patch, otherwise the patch should be 
cancelled with a clear explanation for why it was rejected.

##The list of submitted patches is in the [WWW] Hadoop Review 
##Queue. This is ordered by time of last modification. Committers 
##should scan the list from top-to-bottom, looking for patches that 
##they feel qualified to review and possibly commit.
## Pig doesn't appear to have a review queue yet.  How do we set one up?

For non-trivial changes, it is best to get another committer to 
review your own patches before commit. Use "Submit Patch" like 
other contributors, and then wait for a "+1" from another committer 
before committing.

== Reject ==
Patches should be rejected which do not adhere to the guidelines in 
HowToContribute and to the [http://wiki.apache.org/lucene-hadoop/CodeReviewChecklist CodeReviewChecklist].
should always be polite to contributors and try to instruct and 
encourage them to contribute better patches. If a committer wishes 
to improve an unacceptable patch, then it should first be rejected, 
and a new patch should be attached by the committer for review.

(Pig needs to add its own code review checklist, but for now we are using hadoop's.)

== Commit ==
When you commit a patch, please:

   1.  Add an entry in CHANGES.txt, at the end of the appropriate section. This should include
the Jira issue id, and the name of the contributor.
   2.  Include the Jira issue id in the commit message, along with a short description of
the change and the name of the contributor if it is not you. Be sure to get the issue id right,
as this causes Jira to link to the change in Subversion (use the issue's "All" tab to see
   3.  Resolve the issue as fixed, thanking the contributor. Always set the "Fix Version"
at this point, but please only set a single fix version, the earliest release in which the
change will appear.

##== Dialog ==

##Committers should hang out in the #hadoop room on 
##irc.freenode.net for real-time discussions. However any substantive 
##discussion (as with any off-list project-related discussion) should 
##be re-iterated in Jira or on the developer list.

View raw message