mirror of
https://github.com/jwinterm/modoboa.git
synced 2026-10-18 05:51:26 +02:00
31 lines
726 B
ReStructuredText
31 lines
726 B
ReStructuredText
#################
|
|
How to contribute
|
|
#################
|
|
|
|
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
|