From 2102879616725bc05c070627df2b4a7d54bfaf95 Mon Sep 17 00:00:00 2001 From: deadc0de6 Date: Thu, 28 Mar 2019 16:04:01 +0100 Subject: [PATCH] update doc --- CONTRIBUTING.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4ebd881..6a8f1c9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,13 +36,22 @@ Dotdrop is tested with the use of the [tests.sh](/tests.sh) script. * run the unittest available in [tests directory](/tests) * run the bash script tests in [tests-ng directory](tests-ng) -## How to implement unittest +## testing with unittest -**TODO** +All unittests are available in [tests directory](/tests) +and use [python unittest](https://docs.python.org/3/library/unittest.html). -## How to implement bash script tests +The file [helpers.py](/tests/helpers.py) provides different helper methods +for the tests. -**TODO** +## testing with bash scripts + +The bash scripts are available in [tests-ng directory](tests-ng). +These test entire workflows by simulating the use of dotdrop from end to end +for different use-cases (usually described in their filename). + +Each script starts with the same boiler plate code that you can paste at the +start of your new test (see the head of the file down to `# this is the test`). # Documentation