From cbd37e3d43c908a8038e736ff8e2960c820dee5c Mon Sep 17 00:00:00 2001 From: Matthieu Schaller <matthieu.schaller@durham.ac.uk> Date: Wed, 3 Aug 2016 18:26:06 +0100 Subject: [PATCH] Update the contribution guide to describe the test suite. --- CONTRIBUTING.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 883a63c034..1248883c0a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,12 @@ The SWIFT source code is using a variation of the 'Google' formatting style. The script 'format.sh' in the root directory applies the clang-format-3.8 tool with our style choices to all the SWIFT C source file. Please apply -the formatting script to the files before submitting a merge request. \ No newline at end of file +the formatting script to the files before submitting a merge request. + +The SWIFT code comes with a series of unit tests that are run automatically +when a push to the master branch occurs. The suite can be run by doing a `make +check` in the root directory. Please check that the test suite still +runs with your changes applied before submitting a merge request and add +relevant unit tests probing the correctness of new modules. An example of how +to add a test to the suite can be found by considering the tests/testGreeting +case. \ No newline at end of file -- GitLab