Merge pull request #263 from markusgattol/1fa51ff2008cc

make it clear that using gitflow is optional really

README.rst

@@ -88,3 +88,30 @@ So, please feel free to sprinkle some of this around your systems and
 let the deliciousness come forth.
 
 .. _`Apache 2.0 licence`: http://www.apache.org/licenses/LICENSE-2.0.html
+
+Contribute
+==========
+This world is not salty enough yet... help us make it a saltier place:
+
+* install gitflow e.g. aptitude install git-flow on Debian or from source https://github.com/nvie/gitflow
+* fork the salt repository to you your github account
+* git clone git@github.com:<youraccount>/salt.git
+* cd salt; ./setuprepo.sh
+
+Start contributing... write a test, make sure the test fails, write
+the actual code, make the test pass and if it does, make an atomic
+commit (referencing the issue(s) if this is a fix) and git push to
+your fork. Issue a pull request so one of the saltstack members can
+review it and accept or require/advice a change. Lather, rinse,
+repeat...
+
+* git pull upstream develop
+* write the test, make it fail...
+* pep8, pylint, pychecker
+* commit, push
+* pull request
+
+Following the gitflow branching model is optional i.e. if you prefer a
+different branching model then that's fine. All that setuprepo.sh does
+is provide you with a quick and hassle-free way to setup the same
+branching model that's used for the main repository.

salt/master.py

@@ -541,12 +541,14 @@ class AESFuncs(object):
         # Don't honor private functions
         if func.startswith('__'):
             return self.crypticle.dumps({})
-        # Run the func
-        ret = getattr(self, func)(load)
+        elif func == '_return':
             # Don't encrypt the return value for the _return func
             # (we don't care about the return value, so why encrypt it?)
-        if func == '_return':
             return ret
+        else:
+            # Run the func
+            ret = getattr(self, func)(load)
+            
             # AES Encrypt the return
             return self.crypticle.dumps(ret)
 

setuprepo.sh

@@ -0,0 +1,28 @@
+# run this script right after you cloned/forked the repo
+
+which git-flow 2>/dev/null
+has_gitflow=$?
+if [ ${has_gitflow} -gt 0  -a ! -x /usr/lib/git-core/git-flow ]; then
+  echo
+  echo "*************************************"
+  echo
+  echo "You need gitflow to hack on salt"
+  echo " - https://github.com/nvie/gitflow"
+  echo " - aptitude install git-flow"
+  echo
+exit 1
+fi
+
+git checkout master
+git remote add upstream https://github.com/saltstack/salt.git
+git config push.default tracking          # only push the current branch
+git config branch.autosetuprebase always  # we want a linear history
+
+echo "Configuring gitflow for this repository..."
+git flow init -d
+echo
+echo "gitflow has been setup successfully!"
+echo "See Contribute section at https://github.com/saltstack/salt for further information"
+
+git checkout develop
+git push -u origin develop