[2/3] git commit: docs: Document how to install a pre-commit hook.

[to...@apache.org]

docs: Document how to install a pre-commit hook.


Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/9f02b0cc
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/9f02b0cc
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/9f02b0cc

Branch: refs/heads/trunk
Commit: 9f02b0cc8a63f76dca94c48f6f867781bc3e8cf1
Parents: 367c1f9
Author: Tomaz Muraus <to...@apache.org>
Authored: Sat Oct 26 12:44:32 2013 +0200
Committer: Tomaz Muraus <to...@apache.org>
Committed: Sat Oct 26 12:44:32 2013 +0200

----------------------------------------------------------------------
 docs/development.rst | 24 ++++++++++++++++++++++--
 1 file changed, 22 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/libcloud/blob/9f02b0cc/docs/development.rst
----------------------------------------------------------------------
diff --git a/docs/development.rst b/docs/development.rst
index 224180e..d5c1413 100644
--- a/docs/development.rst
+++ b/docs/development.rst
@@ -11,14 +11,34 @@ This page explains how you can contribute to the Libcloud project. If you get
 stuck at any point during this process, stop by on our IRC channel (#libcloud
 on freenode) and we will do our best to assist you.
 
-Style Guide
+Style guide
 -----------
 
 * We follow `PEP8 Python Style Guide`_
 * Use 4 spaces for a tab
+* Use 79 characters in a line
 * Make sure edited file doesn't contain any trailing whitespace
 * You can verify that your modifications don't break any rules by running the
-  ``pep8 script - e.g. pep8 libcloud/edited_file.py.``
+  ``flake8 script - e.g. flake8 libcloud/edited_file.py.`` or ``tox -e lint``.
+  Second command fill run flake8 on all the files in the repository.
+
+Git pre-commit hook
+-------------------
+
+To make complying with our style guide easier, we provide a git pre-commit hook
+which automatically checks modified Python files for violations of our style
+guide.
+
+You can install it by running following command in the root of the repository
+checkout:
+
+.. sourcecode:: bash
+
+    ln -s contrib/pre-commit.sh .git/hooks/pre-commit
+
+After you have installed this hook it will automatically check modified Python
+files for violations before a commit. If a violation is found, commit will be
+aborted.
 
 General guidelines
 ------------------