Mention how to report bugs

Original-CommitID: ae6b7dca03de0a309c8da4cbfd9abf9bc5ef9f63
AllenInstitute · Jan 25, 2017 · 2736d05 · 2736d05
1 parent 15d6e2c
commit 2736d05
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 0 deletions.
diff --git a/Packages/doc/index.rst b/Packages/doc/index.rst
@@ -5,6 +5,7 @@ Table of Contents
   :maxdepth: 1
 
   Installation instructions <readme>
+  Reporting Bugs <reportingbugs>
   Release Notes <releasenotes>
   filelist
   structlist

diff --git a/README.md b/README.md
@@ -10,6 +10,10 @@
 
 * Download from [bamboo](http://bamboo.corp.alleninstitute.org/browse/MIES-RELEASE/latestSuccessful) below "Shared artifacts"
 
+## Bug reporting
+
+Please have a look at ReportingBugs.md.
+
 ## Full Installation
 
 Pressure control may be implemented with ITC and/or NIDAQ hardware.  For NIDAQ

diff --git a/ReportingBugs.md b/ReportingBugs.md
@@ -0,0 +1,15 @@
+# Bug reporting
+
+In case you find a issue/bug/problem in your MIES installation please contact us at MIES@alleninstitute.org.
+
+We need the following information to be able to help you:
+
+* Output of `MIES Panels->Advanced->Check installation`
+* Screenshots of error dialogs or similiar
+* Steps to reproduce
+
+The following things are, depending on the type of issue, also required:
+
+* Acquired data as packed experiment (pxp), email us for an upload possibility if required
+* In case the generated NWB file is concerned, please include that as well
+* In case the issue concerns the ZeroMQ XOP, the messages in textform will tremendeously help
diff --git a/tools/build-documentation.sh b/tools/build-documentation.sh
@@ -31,6 +31,7 @@ if hash pandoc 2>/dev/null; then
   echo "Start converting markdown files to rst"
 
   pandoc -f markdown_strict "$top_level/README.md" -o readme.rst
+  pandoc -f markdown_strict "$top_level/ReportingBugs.md" -o reportingbugs.rst
 
 else
   echo "Errors building the documentation" 1>&2