[Lucene-hadoop Wiki] Update of "HowToCommit" by DougCutting

[Apache Wiki <wi...@apache.org>]

Dear Wiki user,

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

The following page has been changed by DougCutting:
http://wiki.apache.org/lucene-hadoop/HowToCommit

The comment on the change is:
initial documentation for committers

New page:
= Guide for Hadoop Committers =

This page contains Hadoop-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 [http://lucene.apache.org/hadoop/credits.html credits] page.  This requires changing the XML source in src/docs, running forrest to regenerate the site, manually copying the modified pages to 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 [https://issues.apache.org/jira/secure/IssueNavigator.jspa?requestId=12311124&mode=hide 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.

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.

== 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.
 1. 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.
 1. 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.

Re: [Lucene-hadoop Wiki] Update of "HowToCommit" by DougCutting

[Arun C Murthy <ar...@yahoo-inc.com>]

On Fri, Sep 07, 2007 at 04:49:49PM +0530, Arun C Murthy wrote:
>Apache Wiki wrote:
>>== 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.
>> 1. 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.
>> 1. 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.
>
>I propose the committer also includes the link to the svn revision for 
>that commit to help quickly track changes from jira.
>
>E.g.
>http://svn.apache.org/viewvc?view=rev&revision=573513 for HADOOP-1018
>here: http://issues.apache.org/jira/browse/HADOOP-1018#action_12525661
>

Never mind. Doug pointed out that one sees revisions and changed files in the 'All' tab on jira already... my bad, thanks Doug.

Arun

>Thoughts?
>
>Arun
>
>>
>>== 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.
>

Re: [Lucene-hadoop Wiki] Update of "HowToCommit" by DougCutting

[Arun C Murthy <ar...@yahoo-inc.com>]

Apache Wiki wrote:
> == 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.
>  1. 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.
>  1. 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.

I propose the committer also includes the link to the svn revision for 
that commit to help quickly track changes from jira.

E.g.
http://svn.apache.org/viewvc?view=rev&revision=573513 for HADOOP-1018
here: http://issues.apache.org/jira/browse/HADOOP-1018#action_12525661

Thoughts?

Arun

> 
> == 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.