PatchCheckList (MAHOUT) edited by Grant Ingersoll
Page: http://cwiki.apache.org/confluence/display/MAHOUT/PatchCheckList
Changes:
http://cwiki.apache.org/confluence/pages/diffpagesbyversion.action?pageId=74909&originalVersion=1&revisedVersion=2
Content:
---------------------------------------------------------------------
h1. Patch Check List
So, you want to apply a patch? Here are tips, traps, etc. for dealing with
patches (in no particular order):
# Get a fresh copy of trunk. Or at least make sure you are up to date and
clean your build area. For complex patches, it is recommended you deal with a
fresh checkout.
# Look at the patch and see where it is applied. Ideally it is generated from
the root, but not everyone does this, especially for contrib areas.
# patch \-p 0 \-i <path to patch> Throw a \--dry-run on there if you want to
see what happens w/o screwing up your checkout.
# Did the author write unit tests? Are the unit tests worthwhile?
# How are the benchmark results? contrib/benchmarker may be used to test
performance in before/after scenarios.
# Are the licenses correct on newly added files? Has an ASF license been
granted?
# Update CHANGES.txt. Give proper credit to the authors.
# Make sure you update JIRA by assigning the issue to you so that others know
you are working on it.
# If it is a complex change and you have added to the original author's patch,
it is suggested that you create a new patch and attach that to JIRA so that it
can be discussed.
# How's the documentation, esp. the javadocs?
# Before committing, make sure you add any new documents to SVN. Just b/c the
patch added them doesn't mean you have.
# Run all unit tests, verify all tests pass.
# Generate javadocs, verify no javadoc errors/warnings were introduced by the
patch.
# Put in a meaningful commit message. Reference the JIRA issue when
appropriate.
# Remember to update the issue in JIRA when you have completed it.
# From the top directory "ant rat-sources" to make sure all the files have
license headers.
---------------------------------------------------------------------
CONFLUENCE INFORMATION
This message is automatically generated by Confluence
Unsubscribe or edit your notifications preferences
http://cwiki.apache.org/confluence/users/viewnotifications.action
If you think it was sent incorrectly contact one of the administrators
http://cwiki.apache.org/confluence/administrators.action
If you want more information on Confluence, or have a bug to report see
http://www.atlassian.com/software/confluence
