aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorSimon Butcher <simon.butcher@arm.com>2018-07-23 16:16:04 +0100
committerSimon Butcher <simon.butcher@arm.com>2018-07-23 16:16:04 +0100
commit5a5d03f025dcd170e4580ca5c9c18a6fc85b2f8e (patch)
tree8b833b4f2200079503d6f02903d525d63265891a /CONTRIBUTING.md
parent10f9663fcb933421068efdec0ee24bcbd3e9af09 (diff)
downloadmbedtls-5a5d03f025dcd170e4580ca5c9c18a6fc85b2f8e.zip
mbedtls-5a5d03f025dcd170e4580ca5c9c18a6fc85b2f8e.tar.gz
mbedtls-5a5d03f025dcd170e4580ca5c9c18a6fc85b2f8e.tar.bz2
Add test guidelines to CONTRIBUTING.md
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f55fc28..83e04f8 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -68,6 +68,8 @@ As mentioned, tests that show the correctness of the feature or bug fix should b
Mbed TLS includes a comprehensive set of test suites in the `tests/` directory that are dynamically generated to produce the actual test source files (e.g. `test_suite_mpi.c`). These files are generated from a `function file` (e.g. `suites/test_suite_mpi.function`) and a `data file` (e.g. `suites/test_suite_mpi.data`). The function file contains the test functions. The data file contains the test cases, specified as parameters that will be passed to the test function.
+[A knowledgebase article describing how to add additional tests is available on the Mbed TLS website](https://tls.mbed.org/kb/development/test_suites).
+
A test script `tests/scripts/basic-build-test.sh` is available to show test
coverage of the library. New code contributions should provide a similar level
of code coverage to that which already exists for the library.