diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 81367d26c7de85603aa8b1963e64d7a511270b41..e498c5aa248f6d46a3fce235390c58b97f07ccb9 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`