You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mahout.apache.org by ap...@apache.org on 2014/08/15 17:41:40 UTC
svn commit: r1618216 -
/mahout/site/mahout_cms/trunk/content/developers/patch-check-list.mdtext
Author: apalumbo
Date: Fri Aug 15 15:41:40 2014
New Revision: 1618216
URL: http://svn.apache.org/r1618216
Log:
MAHOUT-1587: Update website to reflect move to GitHub
Modified:
mahout/site/mahout_cms/trunk/content/developers/patch-check-list.mdtext
Modified: mahout/site/mahout_cms/trunk/content/developers/patch-check-list.mdtext
URL: http://svn.apache.org/viewvc/mahout/site/mahout_cms/trunk/content/developers/patch-check-list.mdtext?rev=1618216&r1=1618215&r2=1618216&view=diff
==============================================================================
--- mahout/site/mahout_cms/trunk/content/developers/patch-check-list.mdtext (original)
+++ mahout/site/mahout_cms/trunk/content/developers/patch-check-list.mdtext Fri Aug 15 15:41:40 2014
@@ -2,32 +2,23 @@ Title: Patch Check List
# Patch Check List
-So, you want to apply a patch - or you want to know in more detail what committers look for in your patches?
+So, you want to merge a contribution- or you want to know in more detail what committers look for in your contribution?
Here are tips, traps, etc. for dealing with
-patches:
+PRs:
- - 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.
- - Apply the patch with *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?
- Are the licenses correct on newly added files? Has an ASF license been
granted?
- - Update the [CHANGELOG][1] file. 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 is the documentation, especially the javadocs?
- - Before committing, make sure you add any new documents to SVN. Just because
-the patch added them doesn't mean you have :)
+ - Before committing, make sure you add any new documents to your local Git repo.
- Run all unit tests, verify that all tests pass.
- - Put in a meaningful commit message, referencing the JIRA issue.
- - Remember to update the issue in JIRA when you have completed it.
+ - Lastly, update the [CHANGELOG](https://github.com/apache/mahout/blob/master/CHANGELOG) file. Give proper credit to the authors.
+
+After the above steps are verified and completed, and the contribution is ready to merge, follow the steps in the "Merging a PR" section in: [Handling Github PRs](http://mahout.apache.org/developers/github.html).
+ - Remember to update the issue status in JIRA when you have completed it.
- [1]: https://svn.apache.org/viewvc/mahout/trunk/CHANGELOG?view=markup "CHANGELOG"
\ No newline at end of file
+
+
\ No newline at end of file