From caf05561b6b3c12e70f9f49e3cc40f21e39bd7d1 Mon Sep 17 00:00:00 2001 From: Sean Hammond Date: Fri, 16 Nov 2012 22:46:19 +0100 Subject: [PATCH] [#3020] Add section about keeping up with master --- doc/coding-standards.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/doc/coding-standards.rst b/doc/coding-standards.rst index 6e3d1a9d750..5d92afe26e2 100644 --- a/doc/coding-standards.rst +++ b/doc/coding-standards.rst @@ -72,6 +72,25 @@ Here is an example CKAN commit message:: Following feedback from markw (see #2406). +Keeping Up with master +---------------------- + +When developing on a branch you should periodically pull the latest commits +from the master branch of the central CKAN repo into your feature branch, to +prevent the two branches from diverging from each other too much and becoming +difficult to merge. + +If you haven't already, add the central repo to your development repo as a +remote:: + + git remote add central git://github.com/okfn/ckan.git + git fetch central + +Now, every now and then pull the latest commits from the central master branch +into your feature branch. While on your feature branch, do:: + + git pull central master + Pull Requests & Code Review --------------------------- @@ -93,6 +112,8 @@ branch and it will become part of CKAN! see `Feature Branches`_. - Your branch should contain new or changed tests for any new or changed code, see `Testing`_. + - Your branch should be up to date with the master branch of the central + CKAN repo, see `Keeping Up with master`_. - All the CKAN tests should pass on your branch, see :doc:`test`.