Add documentation for Unit Tests

This commit is contained in:
Dominik Ritter 2016-02-13 21:49:34 +01:00
parent 0d8c05ecb7
commit 34bf1f0bf5
1 changed files with 14 additions and 0 deletions

14
TESTS.md Normal file
View File

@ -0,0 +1,14 @@
# Structure
The Unit-Tests do not follow exactly the file structure of Powerlevel9k itself.
## Basic Tests
Basic Tests belong in `test/powerlevel9k.spec` if they test basic functionality of
Powerlevel9k itself. Basic functions from the `functions` directory have their
Tests in separate files under `test/functions`.
## Segment Tests
These Tests tend to be more complex in setup than the basic tests. To avoid ending
up in a huge single file, there is one file per segment in `test/segments`.