Add the contributing.rst doc in the index

This commit is contained in:
louiz’
2018-09-01 23:12:39 +02:00
parent b9fab4aafb
commit e75b551a52
2 changed files with 15 additions and 9 deletions
+8 -3
View File
@@ -1,5 +1,6 @@
#######################
Contributing to biboumi Contributing to biboumi
======================= #######################
Biboumi’s main workplace is at https://lab.louiz.org/louiz/biboumi Biboumi’s main workplace is at https://lab.louiz.org/louiz/biboumi
@@ -61,11 +62,15 @@ There are two test suites for biboumi:
Once all the dependencies are correctly installed, the tests are run with Once all the dependencies are correctly installed, the tests are run with
`make e2e` .. code-block:: sh
make e2e
To run one or more specific tests, you can do something like this: To run one or more specific tests, you can do something like this:
`make biboumi && python3 ../tests/end_to_end self_ping basic_handshake_success` .. code-block:: sh
make biboumi && python3 ../tests/end_to_end self_ping basic_handshake_success
This will run two tests, self_ping and basic_handshake_success. This will run two tests, self_ping and basic_handshake_success.
+1
View File
@@ -20,3 +20,4 @@ XMPP client as if these channels were XMPP MUCs.
install install
admin admin
user user
contributing