From ab8ebdd843658b5a59bf556bb5665f9668c268ff Mon Sep 17 00:00:00 2001 From: Johannes Pfeifer <jpfeifer@gmx.de> Date: Wed, 18 Aug 2021 12:36:14 +0000 Subject: [PATCH] Update CONTRIBUTING.md (cherry picked from commit 7037940124184b224f58a40cd7e1ea3b1c351c6b) --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 81367d26c7..e498c5aa24 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -101,7 +101,8 @@ It's useful to contribute `.mod` files that test some aspect of Dynare that is n ### Unitary Tests So-called unitary tests allow the test suite to check the correct functioning of the Matlab functions contained in Dynare. To add a unitary test you need to -1. add the keyword ` % --*-- Unitary tests --*--` at the end of the `function` header to tell the testsuite that the file contains unitary tests. 1. Add the particular tests at the end of the file (either after a `return` or the closing `end`) by +1. add the keyword ` % --*-- Unitary tests --*--` at the end of the `function` header to tell the testsuite that the file contains unitary tests. +1. Add the particular tests at the end of the file (either after a `return` or the closing `end`) by a. Starting a test with `%@test:INTEGER` b. Adding a Matlab test code that provides a pass/fail indicator `T` that takes on `true` if the test passed. c. Closing the test with `%@eof:INTEGER` -- GitLab