diff options
| author | louiz’ <louiz@louiz.org> | 2018-09-01 23:12:39 +0200 |
|---|---|---|
| committer | louiz’ <louiz@louiz.org> | 2018-09-01 23:12:39 +0200 |
| commit | e75b551a52f0f426b3bc098318d66ec9c75fc9a1 (patch) | |
| tree | a71d033a7cbea0803e99aa5f3154fb25ddb5c1f8 | |
| parent | b9fab4aafb97748d7842b4074c647d2f1ad78e7a (diff) | |
| download | biboumi-e75b551a52f0f426b3bc098318d66ec9c75fc9a1.tar.gz biboumi-e75b551a52f0f426b3bc098318d66ec9c75fc9a1.tar.bz2 biboumi-e75b551a52f0f426b3bc098318d66ec9c75fc9a1.tar.xz biboumi-e75b551a52f0f426b3bc098318d66ec9c75fc9a1.zip | |
Add the contributing.rst doc in the index
| -rw-r--r-- | doc/contributing.rst (renamed from CONTRIBUTING.rst) | 23 | ||||
| -rw-r--r-- | doc/index.rst | 1 |
2 files changed, 15 insertions, 9 deletions
diff --git a/CONTRIBUTING.rst b/doc/contributing.rst index 502acdc..ee499fc 100644 --- a/CONTRIBUTING.rst +++ b/doc/contributing.rst @@ -1,5 +1,6 @@ +####################### Contributing to biboumi -======================= +####################### Biboumi’s main workplace is at https://lab.louiz.org/louiz/biboumi @@ -61,18 +62,22 @@ There are two test suites for biboumi: Once all the dependencies are correctly installed, the tests are run with - `make e2e` +.. code-block:: sh - To run one or more specific tests, you can do something like this: + make e2e - `make biboumi && python3 ../tests/end_to_end self_ping basic_handshake_success` +To run one or more specific tests, you can do something like this: - This will run two tests, self_ping and basic_handshake_success. +.. code-block:: sh - To write additional tests, you need to add a Scenario - into `the __main__.py file`_. If you have problem running this end-to-end - test suite, or if you struggle with this weird code (that would be - completely normal…), don’t hesitate to ask for help. + make biboumi && python3 ../tests/end_to_end self_ping basic_handshake_success + +This will run two tests, self_ping and basic_handshake_success. + +To write additional tests, you need to add a Scenario +into `the __main__.py file`_. If you have problem running this end-to-end +test suite, or if you struggle with this weird code (that would be +completely normal…), don’t hesitate to ask for help. All these tests automatically run with various configurations, on various diff --git a/doc/index.rst b/doc/index.rst index ca1bf0d..b97c8fd 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -20,3 +20,4 @@ XMPP client as if these channels were XMPP MUCs. install admin user + contributing |