Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Guide for Hive Committers

...

This page contains guidelines for committers of the Apache Hadoop Hive project. (If you're currently a contributor, and are interested in how we add new committers, read BecomingACommitter)

New committers

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

...

The first act of a new core committer is typically to add their name to the credits page. This requires changing the XML source in http://svn.apache.org/repos/asf/hadoop/core/site/author/src/documentation/content/xdocs/credits.xmlImage Removed. Once done, update the Hive website as described herein the Documentation section below.

Review

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

...

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

...

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). Example: "HIVE-123. Add awesomesauce to the optimizer. (Mike Brakestoner via jvs)"
  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.
  4. Use the -E option to make sure that empty files are removed during the commit.

...

Committing Documentation

Hive's official documentation is authored using Forrest. To commit documentation changes you must have Forrest installed and the forrest executable on your $PATH. Note that the current version (0.8) doesn't work properly with Java 6, use Java 5 instead. Documentation is of two types:

...

  1. Commit the changes to trunk and note down the revision number, say 4001. (Revision number is displayed as response to your svn commit command).
    2. Check out the desired branch and execute this command from the root directory.
    Code Block
    svn merge -r 4000:4001 https://svn.apache.org/repos/asf/hadoop/hive/trunk .
    svn commit
    

Dialog

Committers should hang out in the #hive 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.