mirror of
https://github.com/jwinterm/modoboa.git
synced 2026-10-17 05:41:25 +02:00
Refactored documentation.
This commit is contained in:
+29
-3
@@ -1,4 +1,30 @@
|
||||
Rules
|
||||
=================
|
||||
#################
|
||||
How to contribute
|
||||
#################
|
||||
|
||||
.. include:: ../CONTRIBUTING.rst
|
||||
Contributions 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 add some code, 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
|
||||
|
||||
|
||||
.. toctree::
|
||||
|
||||
contributing/getting_started
|
||||
contributing/plugin_api
|
||||
contributing/events
|
||||
|
||||
Reference in New Issue
Block a user