Merge pull request #918 from bearstech/contributing

Contributing

CONTRIBUTING.rst

@@ -0,0 +1,21 @@
+Contribution are always welcome but please try to follow those few rules:
+
+- Modoboa tries to respect the `PEP8 <https://www.python.org/dev/peps/pep-0008/>`_.
+
+- If you're adding some code, try to add some tests too. You can run the tests
+  suite locally by using `tox <https://testrun.org/tox/latest/config.html>`_
+
+There are also a few commands that can help you to contribute:
+
+Start a basic Modoboa instance with a few fixture::
+
+   $ tox -e serve
+
+You can log in with admin/password.
+
+Build the docs to see your changes::
+
+   $ tox -e doc
+   $ firefox .tox/doc/tmp/html/index.html
+
+

MANIFEST.in

@@ -1,4 +1,4 @@
-include README.rst LICENSE requirements.txt
+include README.rst CONTRIBUTING.rst LICENSE requirements.txt
 recursive-include modoboa *.html *.js *.css *.png *.po *.mo *.json *.gif *.ttf *.woff
 recursive-include modoboa/core/templates *.tpl
 recursive-include modoboa/core/commands/templates *.tpl

README.rst

@@ -38,7 +38,7 @@ Main features
 Documentation
 *************
 
-A detailed `documentation <https://modoboa.readthedocs.org/>`_ will help you
+A detailed `documentation <https://modoboa.readthedocs.io/>`_ will help you
 to install, use or extend Modoboa.
 
 *************

doc/contributing.rst

@@ -0,0 +1,4 @@
+Rules
+=================
+
+.. include:: ../CONTRIBUTING.rst

doc/contributors.rst

@@ -0,0 +1,6 @@
+Contributors
+============
+
+.. Add yourself
+
+- `Bearstech <http://bearstech.com>`_

doc/index.rst

@@ -62,3 +62,13 @@ Additional resource
 
    additional/migrating
    additional/virtualmachine
+
+*******************
+Contributing
+*******************
+
+.. toctree::
+   :maxdepth: 2
+
+   contributing
+   contributors

tox.ini

@@ -25,3 +25,14 @@ setenv =
     DJANGO_SETTINGS_MODULE=test_project.settings
     DB=SQLITE
     DEBUG=1
+
+[testenv:doc]
+changedir = doc
+deps =
+    sphinx
+    Pygments
+whitelist_externals =
+    rm
+commands =
+    rm -Rf {envtmpdir}/doctrees {envtmpdir}/html
+    sphinx-build -b html -d {envtmpdir}/doctrees . {envtmpdir}/html