summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Lindsley <daniel@toastdriven.com>2013-07-24 16:23:52 -0700
committerDaniel Lindsley <daniel@toastdriven.com>2013-07-24 16:45:10 -0700
commit80a419c35498bfabfd72e8221262c679243e75fe (patch)
treebde7e444860e7c3c8cbd15b2e330de4cabb02c04
parent1c4149989baaa6664b54683cefb4dd933e60d51a (diff)
downloadboto-80a419c35498bfabfd72e8221262c679243e75fe.tar.gz
Added notes about merging pull requests.
-rw-r--r--docs/source/contributing.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst
index ac9305a3..80821995 100644
--- a/docs/source/contributing.rst
+++ b/docs/source/contributing.rst
@@ -202,3 +202,26 @@ and uses `restructured text`_ for the markup language.
.. _virtualenvwrapper: http://www.doughellmann.com/projects/virtualenvwrapper/
.. _sphinx: http://sphinx.pocoo.org/
.. _restructured text: http://sphinx.pocoo.org/rest.html
+
+
+Merging A Branch (Core Devs)
+============================
+
+* All features/bugfixes should go through a review.
+
+ * This includes new features added by core devs themselves. The usual
+ branch/pull-request/merge flow that happens for community contributions
+ should also apply to core.
+
+* Ensure there is proper test coverage. If there's a change in behavior, there
+ should be a test demonstrating the failure before the change & passing with
+ the change.
+
+ * This helps ensure we don't regress in the future as well.
+
+* Merging of pull requests is typically done with
+ ``git merge --no-ff <remote/branch_name>``.
+
+ * GitHub's big green button is probably OK for very small PRs (like doc
+ fixes), but you can't run tests on GH, so most things should get pulled
+ down locally.