Add more info on how the report a bug or contribute (ref ##128).

docs/contribute.rst

@@ -0,0 +1,38 @@
+=========================
+ Contributing guidelines
+=========================
+
+.. include:: ../CONTRIBUTING.rst
+
+Setting up the development environment
+--------------------------------------
+
+ Using a virtualenv_::
+
+    git clone https://github.com/saimn/sigal.git
+    cd sigal
+    virtualenv venv
+    . venv/activate
+
+Install sigal in development mode::
+
+    pip install -e .
+
+Install additional dependencies for development (Sphinx, ...)::
+
+    pip install -r requirements.txt
+
+Building the docs
+-----------------
+
+- Run ``make docs`` (or ``make html`` in the ``docs/`` directory).
+
+Running the test suite
+----------------------
+
+- Run ``make test`` (or ``py.test``).
+- Run ``make coverage`` to get the coverage report.
+- Using tox_ you can also run the tests on multiple versions of python.
+
+.. _tox: https://testrun.org/tox/
+.. _virtualenv: https://virtualenv.pypa.io/

docs/index.rst

@@ -13,4 +13,5 @@ Documentation
    image_information
    themes
    plugins
+   contribute
    changelog