Differences between revisions 6 and 7
Revision 6 as of 2007-12-12 18:16:15
Size: 4137
Editor: c-76-103-181-218
Comment: update doc docs
Revision 7 as of 2007-12-12 18:20:32
Size: 4187
Editor: c-76-103-181-218
Comment: fix broken link and stale url
Deletions are marked like this. Additions are marked like this.
Line 12: Line 12:
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/src/documentation/content/xdocs/credits.xml. Once done, update the Hadoop website as described [#CommitToWebsite here]. 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 http://svn.apache.org/repos/asf/lucene/hadoop/site/author/src/documentation/content/xdocs/credits.xml. Once done, update the Hadoop website as described [#Documentation here].
Line 35: Line 35:
[[Anchor(CommitDocs)]] [[Anchor(Documentation)]]

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:

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 http://svn.apache.org/repos/asf/lucene/hadoop/site/author/src/documentation/content/xdocs/credits.xml. Once done, update the Hadoop website as described [#Documentation here].

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.

Reject

Patches should be rejected which do not adhere to the guidelines in HowToContribute and to the CodeReviewChecklist. Committers 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.

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 these).
  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.

Anchor(Documentation)

Committing Documentation

Hadoop's official documentation is authored using [http://forrest.apache.org/ Forrest]. To commit documentation changes you must have Forrest installed and the forrest executable on your $PATH. Documentation is of two types:

  1. End-user documentation, versioned with releases; and,
  2. The website. This is maintained separately in subversion, republished as it is changed.

To commit end-user documentation changes to trunk or a branch, ask the user to submit only changes made to the *.xml files in src/docs. Apply that patch, run ant docs to generate the html, and then commit. End-user documentation is only published to the web when releases are made, as described in HowToRelease.

To commit changes to the website and re-publish them:

svn co https://svn.apache.org/repos/asf/lucene/hadoop/site
cd site
ant
firefox publish/index.html # preview the changes
svn stat                   # check for new pages
svn add                    # add any new pages
svn commit
ssh people.apache.org
cd /www/lucene.apache.org/hadoop
svn up

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.

HowToCommit (last edited 2019-02-07 18:24:05 by MartonElek)