Skip to content

Commit

Permalink
Whitelist a "test" directory for unit tests
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
ianfixes authored and ikatz-drizly committed Jan 3, 2021
1 parent 6a177eb commit 5f3f7ba
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/library-specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 5f3f7ba

Please sign in to comment.