ISSUE_TEMPLATE.md

   1 ## How to file an issue
   2
   3 If you encounter an issue with SmoothieWare, you are welcome to
   4 [submit an issue](https://github.com/Smoothieware/Smoothieware/issues)
   5
   6 **Please note** while other projects will use github issues as a general discussion forum, we try to restrict the issues to **actual** issues only. If you want to discuss new features, ask questions, or anything else that is not an issue, please go to the Smoothie forums, mailing lists, IRC, social media etc.
   7
   8 **DO NOT ASK QUESTIONS HERE** they will not be answered and the issue will be summarily closed.
   9
  10 Before you do that for the first time though please take a moment to read the
  11 following section *completely*. Thank you! :)
  12
  13 ### What should I do before submitting an issue?
  14
  15 1. **this is not the right issue tracker if you are running a
  16    forked version of Smoothieware**. Seek help for such unofficial versions from
  17    the people maintaining them instead.
  18
  19 2. Please make sure to **test out the current edge version** of Smoothieware to see
  20    whether the problem you are encountering still exists, and **test with a clean config**.
  21
  22 3. The problem still exists? Then please look through the
  23    [existing tickets](https://github.com/Smoothieware/Smoothieware/issues?state=open)
  24    to check if there already exists a report of the issue you are encountering.
  25
  26    **Very important:** Please make absolutely sure that if you find a bug that looks like
  27    it is the same as your's, it actually behaves the same as your's. E.g. if someone gives steps
  28    to reproduce his bug that looks like your's, reproduce the bug like that if possible,
  29    and only add a "me too" if you actually can reproduce the same
  30    issue. Also **provide all information** as [described below](#what-should-i-include-in-a-bug-report)
  31    and whatever was additionally requested over the course of the ticket
  32    even if you "only" add to an existing ticket. The more information available regarding a bug, the higher
  33    the chances of reproducing and solving it. But "me too" on an actually unrelated ticket
  34    makes it more difficult due to on top of having to figure out the original problem
  35    there's now also a [red herring](https://en.wikipedia.org/wiki/Red_herring) interfering - so please be
  36    very diligent here!
  37
  38 ### What should I include in a bug report?
  39
  40 Always use the following template (you can remove what's within `[...]`, that's
  41 only provided here as some additional information for you), **even if only adding a
  42 "me too" to an existing ticket**:
  43
  44 #### What were you doing?
  45
  46     [Please be as specific as possible here. The maintainers will need to reproduce
  47     your issue in order to fix it and that is not possible if they don't know
  48     what you did to get it to happen in the first place. If you encountered
  49     a problem with specific files of any sorts, make sure to also include a link to a file
  50     with which to reproduce the problem.]
  51
  52 #### What did you expect to happen?
  53
  54 #### What happened instead?
  55
  56 #### Branch & Commit or Version of Smoothieware
  57
  58     [Can be found with the version command. (@version in pronterface)]
  59
  60 #### Hardware model you are using (Make, and version)
  61
  62     [eg Smoothieboard 5X V1b, Azteeg X5 Mini V2, ... etc]
  63
  64 #### Host and Operating System running the Host
  65
  66     [eg Pronterface, Octoprint, linux x64]
  67
  68 #### Link to and console logs
  69
  70     [On gist.github.com or pastebin.com. Always include and never truncate.]
  71
  72 #### Link to running config and M503 results
  73
  74     [On gist.github.com or pastebin.com. Always include and never truncate.]
  75
  76 I have read the [Wiki](http://smoothieware.org) and Especially the [Trouble Shooting section](http://smoothieware.org/troubleshooting)...
  77
  78 Copy-paste this template **completely**. Do not skip any lines!
  79
  80 It might happen that you are asked to provide a more thorough crash log which you can find out how to do [here](http://smoothieware.org/mri-debugging
  81 )