Guide for HCatalog Committers

This page contains HCatalog-specific guidelines for committers.

New committers

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

Review

HCatalog 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 have 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.

For non-trivial changes, you must get another committer to review your own patches before committing them.

Issues in the Patch Available state are ready for review.

Reject

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

Patches are rejected by editing the issue and adding a comment that politely details the reason(s) for rejection.

Commit

When you commit a patch:

  1. Add an entry in CHANGES.txt, at the beginning of the appropriate section (this is so that most recent patches appear first in CHANGES.txt). This should include the JIRA issue id, the name of the contributor, and the name of the committer (if different from 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. Do not close the issue.

Website Changes

HCatalog uses svnpubsub for managing the website (setup in INFRA-5862). To update the website, follow these steps:

  • Install forrest - The 0.9 tar.gz version from the archive is confirmed to be working for our build.
  • Checkout site documentation: svn co https://svn.apache.org/repos/asf/incubator/hcatalog/site/
  • Edit files in author/src/documentation/content/xdocs. See http://forrest.apache.org/ for documentation.
  • Build the site: ant -Dforrest.home=<forresthome> where forresthome is the directory you installed forrest in.
  • Inspect what's in build/site with your browser
  • Once you are happy with the outcome, commit your changes. svnpubsub will update the public website immediately, so only commit when you are ready to publish the public site. 
            svn add ...
        svn commit -m "blah blah"
  • No labels