diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/dev/workflow.rst | 35 | ||||
| -rw-r--r-- | docs/index.rst | 1 | ||||
| -rw-r--r-- | docs/man/leap.1 | 34 |
3 files changed, 69 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 diff --git a/docs/man/leap.1 b/docs/man/leap.1 new file mode 100644 index 00000000..aaa614bb --- /dev/null +++ b/docs/man/leap.1 @@ -0,0 +1,34 @@ +.\" groff -man -Tascii foo.1 +.TH LEAP 1 "July 2012" leap "User manual" +.SH NAME +leap \- the internet encryption toolkit +.SH SYNOPSIS +.B leap +.RI [ OPTIONS ] +.SH DESCRIPTION +.B leap +allows to ... blah blah ... +.SH OPTIONS +.IP "-d, --debug" +Show additional information on the command line. +.IP "-h, --help" +Show information about the usage of the command. +.SH FILES +.TP +.I /usr/share/polkit-1/actions/net.openvpn.gui.leap.policy +The PolicyKit definitions of the privileges used by leap, e.g. to run openvpn as root. To change the privileges please have a look at +.BR PolicyKit.conf (1). +.SH DIAGNOSTICS +By default leaps logs to ... /dev/null. Furthermore you +can foobarize yourself. +.SH EXTRA TIPS +Trust your technolust! +.SH HOMEPAGE +http://leap.se +.SH BUGS +You can report bugs at the bugtracker site of leap: +http://leap.se/code +.SH AUTHOR +This manpage written by kali <kaliyuga at riseup dot net> for the debian package, but obviously can be used for any other distribution. +.SH SEE ALSO +.BR PolicyKit.conf (7) |