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