aboutsummaryrefslogtreecommitdiff
path: root/brunch/tests/README
diff options
context:
space:
mode:
Diffstat (limited to 'brunch/tests/README')
-rw-r--r--brunch/tests/README11
1 files changed, 11 insertions, 0 deletions
diff --git a/brunch/tests/README b/brunch/tests/README
new file mode 100644
index 0000000..ac0c826
--- /dev/null
+++ b/brunch/tests/README
@@ -0,0 +1,11 @@
+Each file in this directory should provide a stubbed or faked test for
+the brunch command. The primary purpose is not execution correctness,
+but to fill the coverage gaps in exercising the python prior to better
+unittest coverage.
+
+Additionally, this path may be used for landing tests for known fixed
+bugs to limit regressions where they don't fit into the standard
+testing options.
+
+See test-helpers for an example of how to setup a temporary path
+and to stub out backing commands.