From 5f3f7ba985ac4b1769207ebde5588eaec79e1d35 Mon Sep 17 00:00:00 2001 From: Ian Date: Sun, 3 Jan 2021 00:38:28 -0500 Subject: [PATCH] Whitelist a "test" directory for unit tests Several unit testing systems exist for Arduino libraries; this patch creates an official "space" within a library to hold whatever files may relate to that functionality. Unlike "Extras", the test files would not become part of the bundled library. --- docs/library-specification.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/library-specification.md b/docs/library-specification.md index a03dcb9217f..36e5788b227 100644 --- a/docs/library-specification.md +++ b/docs/library-specification.md @@ -216,6 +216,12 @@ that weights a few kilobytes may not be such a good idea. The content of the _extras_ folder is totally ignored by the Arduino development software; you are free to put anything inside. +#### Unit Tests + +A **test** folder can be used by the developer to store any & all files related to unit testing the library. + +The content of the _test_ folder is totally ignored by the IDE and will _not_ be bundled with the library. + ### Keywords A list of keywords for the library may be specified in a file named keywords.txt located in the root of the library