This page contains Pig-specific guidelines for committers.
New committers
New committers are encouraged to first read Apache's generic
committer documentation:
Review
Pig 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 Pig 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. Set the 'Patch Available' checkbox 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. 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 un-setting the 'Patch Available' checkbox and adding a comment that politely details the reason(s) for rejection.
Commit
When you commit a patch, please:
- 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, and the name of the contributor.
- 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).
- 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.
In addition to code changes, changes to the site documentation might be necessary. If so, please, follow the steps described in HowToDocument#UpdatingthePigSiteDocumentation.