summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDominik Ritter <dritter03@googlemail.com>2016-02-13 23:49:34 +0300
committerDominik Ritter <dritter03@googlemail.com>2016-02-13 23:49:34 +0300
commit34bf1f0bf571d5116dc783f0d50d0aa99ff5c5c1 (patch)
treee7625b0af29c810643b750f52a3a8cf090ca67a5
parent0d8c05ecb7b7a02a42636b1d3600af5535e43d81 (diff)
Add documentation for Unit Tests
-rw-r--r--TESTS.md14
1 files changed, 14 insertions, 0 deletions
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`.