diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 000000000..3007e5e4e --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,21 @@ +Contribution are always welcome but please try to follow those few rules: + +- Modoboa tries to respect the `PEP8 `_. + +- If you're adding some code, try to add some tests too. You can run the tests + suite locally by using `tox `_ + +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 + + diff --git a/MANIFEST.in b/MANIFEST.in index efcdcdd0c..a5df87347 100644 --- a/MANIFEST.in +++ b/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 diff --git a/README.rst b/README.rst index 4620a0e64..bc2388426 100644 --- a/README.rst +++ b/README.rst @@ -38,7 +38,7 @@ Main features Documentation ************* -A detailed `documentation `_ will help you +A detailed `documentation `_ will help you to install, use or extend Modoboa. ************* diff --git a/doc/contributing.rst b/doc/contributing.rst new file mode 100644 index 000000000..f31145f8c --- /dev/null +++ b/doc/contributing.rst @@ -0,0 +1,4 @@ +Rules +================= + +.. include:: ../CONTRIBUTING.rst diff --git a/doc/contributors.rst b/doc/contributors.rst new file mode 100644 index 000000000..0280b769a --- /dev/null +++ b/doc/contributors.rst @@ -0,0 +1,6 @@ +Contributors +============ + +.. Add yourself + +- `Bearstech `_ diff --git a/doc/index.rst b/doc/index.rst index 2ff8cb74b..fa9ecd85a 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -62,3 +62,13 @@ Additional resource additional/migrating additional/virtualmachine + +******************* +Contributing +******************* + +.. toctree:: + :maxdepth: 2 + + contributing + contributors diff --git a/tox.ini b/tox.ini index 0e19beca8..185d3e9e0 100644 --- a/tox.ini +++ b/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