aboutsummaryrefslogtreecommitdiff
path: root/docs/manual/Contributing.Bugs.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/manual/Contributing.Bugs.md')
-rw-r--r--docs/manual/Contributing.Bugs.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/manual/Contributing.Bugs.md b/docs/manual/Contributing.Bugs.md
new file mode 100644
index 0000000..9904273
--- /dev/null
+++ b/docs/manual/Contributing.Bugs.md
@@ -0,0 +1,20 @@
+# Reporting bugs
+
+Please include the following when reporting bugs:
+* Operating system used
+* Version of Qt used
+* Detailed explanation of the bug:
+ * what was done
+ * what was expected
+ * what happened
+
+An example of a bad bug report is:
+> Something happened, and what I pressed the button it broke.
+
+An exmaple of a good bug report is:
+> When I opened the Page menu and pressed Print to PDF, nothing happened.
+
+You can fill out this template when submitting a bug report
+> I'm using (Windows? Linux?)
+>
+> The smolbote version is (0.1? 0.2? 1.0?)