summaryrefslogtreecommitdiff
path: root/tests/cloud_tests/configs/bugs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'tests/cloud_tests/configs/bugs/README.md')
-rw-r--r--tests/cloud_tests/configs/bugs/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/tests/cloud_tests/configs/bugs/README.md b/tests/cloud_tests/configs/bugs/README.md
new file mode 100644
index 00000000..09ce0765
--- /dev/null
+++ b/tests/cloud_tests/configs/bugs/README.md
@@ -0,0 +1,13 @@
+# Bug Test Configs
+
+## purpose
+Configs that reproduce bugs filed against cloud-init. Having test configs for
+cloud-init bugs ensures that the fixes do not break in the future, and makes it
+easy to see how many systems and platforms are effected by a new bug.
+
+## structure
+Should have one test config for most bugs filed. The name of the test should
+contain ``lp`` followed by the bug number. It may also be useful to add a
+comment to each bug config with a summary copied from the bug report.
+
+# vi: ts=4 expandtab