summaryrefslogtreecommitdiff
path: root/tests/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'tests/README.md')
-rw-r--r--tests/README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/tests/README.md b/tests/README.md
new file mode 100644
index 0000000..9cf09c6
--- /dev/null
+++ b/tests/README.md
@@ -0,0 +1,6 @@
+# Tests
+**Test folders names convention:**
+- **m** senders and **n** receivers is written `<m>s<n>r` *(ex: 1s5r)*
+- **n** nodes is written `<n>n` *(ex: 5n)*
+- Tests names follow the following format `<title>_<m>s<n>r` or `<title>_<n>n` *(ex: simple_send_rcv_1s5r, ping_pong_2n)*
+- Tests that test **elementary API functions** should start with the **simple** keyword