diff options
Diffstat (limited to 'doc/source/contributing.rst')
| -rw-r--r-- | doc/source/contributing.rst | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst new file mode 100644 index 0000000..87665cd --- /dev/null +++ b/doc/source/contributing.rst @@ -0,0 +1,33 @@ +Contributing +============ + +Code is hosted `on GitHub`_. Submit bugs to the Designate project on +`Launchpad`_. Submit code to the stackforge/python-designateclient project using +`Gerrit`_. + +.. _on GitHub: https://github.com/stackforge/python-designateclient +.. _Launchpad: https://launchpad.net/designate +.. _Gerrit: http://wiki.openstack.org/GerritWorkflow + +Here's a quick summary: + +Install the git-review package to make life easier + +.. code-block:: shell-session + + pip install git-review + +Branch, work, & submit: + +.. code-block:: shell-session + + # cut a new branch, tracking master + git checkout --track -b bug/id origin/master + # work work work + git add stuff + git commit + # rebase/squash to a single commit before submitting + git rebase -i + # submit + git-review + |