From 34bf1f0bf571d5116dc783f0d50d0aa99ff5c5c1 Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Sat, 13 Feb 2016 21:49:34 +0100 Subject: [PATCH] Add documentation for Unit Tests --- TESTS.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 TESTS.md diff --git a/TESTS.md b/TESTS.md new file mode 100644 index 00000000..d4e663dc --- /dev/null +++ b/TESTS.md @@ -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`.