summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorDylan Baker <dylan@pnwbakers.com>2017-08-18 10:48:44 -0700
committerDylan Baker <dylan@pnwbakers.com>2017-08-18 15:44:42 -0700
commit948479dbbe45b1b74f6a47a91c197c024258de9e (patch)
tree813dc6fd268b52a7613988b5bdf51563dcd4ccc4 /.github
parent188d79a0189b480656542a09be348fcbf506f33d (diff)
github: Add a template to be used automatically for filing issues
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 00000000..b1eaa147
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,28 @@
+Please ensure that the following information is filled before filing
+--------------------------------------------------------------------
+
+Please try to verify that the issue exists in the latest release or, even
+better, the current master.
+
+Please run alot again with the options `-d debug -l log`.
+
+Software Versions
+-----------------
+
+Python version:
+
+Alot version (either a number or sha for master):
+
+Observed behavior
+-----------------
+
+Please include any tracebacks or error information in the log file that you
+generated, as well as a description of the behavior. Please don't post the
+whole log file blindly as it might contain sensitive information and might be
+quite big. A traceback and ~10 lines before and after is probably sufficient.
+
+
+Expected behavior
+-----------------
+
+Please explain what behavior you expect to see.