Skip to content

Commit

Permalink
make it easier for folks to start contributing
Browse files Browse the repository at this point in the history
Signed-off-by: Markus Gattol <[email protected]>
  • Loading branch information
dillongreen committed Nov 23, 2011
1 parent 02d3b10 commit 8e44130
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,3 +88,25 @@ 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 [email protected]:<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
28 changes: 28 additions & 0 deletions setuprepo.sh
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 8e44130

Please sign in to comment.