summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorkali <kali@leap.se>2013-01-25 18:13:55 +0900
committerkali <kali@leap.se>2013-01-25 18:13:55 +0900
commit51a99d6405bff732a37ad561b75cacfc13f2173d (patch)
treebef2322fa8fbd6c53d073d7e10aca1f1f458187d /docs
parent71cd4575a2641272f966cdb47a4f9504f31668a5 (diff)
updated docs about dev workflow
Diffstat (limited to 'docs')
-rw-r--r--docs/dev/workflow.rst35
-rw-r--r--docs/index.rst1
2 files changed, 35 insertions, 1 deletions
diff --git a/docs/dev/workflow.rst b/docs/dev/workflow.rst
index 3f773712..5ceccca4 100644
--- a/docs/dev/workflow.rst
+++ b/docs/dev/workflow.rst
@@ -5,4 +5,37 @@ Development Workflow
This section documents the workflow that the LEAP project team follows and expects for the code contributions.
-XXX
+Code formatting
+---------------
+In one word: `PEP8`_.
+
+`autopep8` might be your friend. or eat your code.
+
+.. _`PEP8`: http://www.python.org/dev/peps/pep-0008/
+.. _`autopep8`: http://pypi.python.org/pypi/autopep8
+
+Dependencies
+------------
+If you introduce a new dependency, please add it under ``pkg/requirements`` or ``pkg/test-requirements`` as appropiate, under the proper module section.
+
+Git flow
+--------
+See `A successful git branching model <http://nvie.com/posts/a-successful-git-branching-model/>`_ for more information. The slight modification we make is that release tags are made in the release branch before getting merged to master, rather than getting tagged in master.
+
+.. image:: https://leap.se/code/attachments/13/git-branching-model.png
+
+The author of the aforementioned post has also a handy pdf version of it: `branching_model.pdf`_
+
+A couple of tools that help to follow this process are `git-flow`_ and `git-sweep`_.
+
+.. _`branching_model.pdf`: https://leap.se/code/attachments/14/Git-branching-model.pdf
+.. _`git-flow`: https://github.com/nvie/gitflow
+.. _`git-sweep`: http://pypi.python.org/pypi/git-sweep
+
+Merge into integration branch
+-----------------------------
+All code ready to be merged into the integration branch is expected to:
+
+* Have tests
+* Be documented
+* Pass existing tests: do **run_tests.sh** and **tox -v**. All feature branches are automagically built by our `buildbot farm <http://lemur.leap.se:8010/grid>`_. So please check your branch is green before merging it it to `develop`. Rebasing against the current tip of the integration when possible is preferred in order to keep a clean history.
diff --git a/docs/index.rst b/docs/index.rst
index a57e030f..3e1a603f 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -41,6 +41,7 @@ If you want to contribute to the project, we wrote this for you.
dev/environment
dev/tests
+ dev/workflow
dev/resources
dev/internationalization