[clinton/Smoothieware.git] / ISSUE_TEMPLATE.md

## How to file an issue

If you encounter an issue with SmoothieWare, you are welcome to
[submit an issue](https://github.com/Smoothieware/Smoothieware/issues)

**YOU MUST** provide the complete output from the version command or M115, the config and the output from M503, otherwise the issue will be summarily closed.

**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.

**DO NOT ASK QUESTIONS HERE** they will not be answered and the issue will be summarily closed.

Before you do that for the first time though please take a moment to read the
following section *completely*. Thank you! :)

### What should I do before submitting an issue?

1. **this is not the right issue tracker if you are running a
   forked version of Smoothieware**. Seek help for such unofficial versions from
   the people maintaining them instead.

2. Please make sure to **test out the current edge version** of Smoothieware to see
   whether the problem you are encountering still exists, and **test with a clean config**.

3. The problem still exists? Then please look through the
   [existing tickets](https://github.com/Smoothieware/Smoothieware/issues?state=open)
   to check if there already exists a report of the issue you are encountering.

   **Very important:** Please make absolutely sure that if you find a bug that looks like
   it is the same as your's, it actually behaves the same as your's. E.g. if someone gives steps
   to reproduce his bug that looks like your's, reproduce the bug like that if possible,
   and only add a "me too" if you actually can reproduce the same
   issue. Also **provide all information** as [described below](#what-should-i-include-in-a-bug-report)
   and whatever was additionally requested over the course of the ticket
   even if you "only" add to an existing ticket. The more information available regarding a bug, the higher
   the chances of reproducing and solving it. But "me too" on an actually unrelated ticket
   makes it more difficult due to on top of having to figure out the original problem
   there's now also a [red herring](https://en.wikipedia.org/wiki/Red_herring) interfering - so please be
   very diligent here!

### What should I include in a bug report?

Always use the following template (you can remove what's within `[...]`, that's
only provided here as some additional information for you), **even if only adding a
"me too" to an existing ticket**:

#### What were you doing?

    [Please be as specific as possible here. The maintainers will need to reproduce
    your issue in order to fix it and that is not possible if they don't know
    what you did to get it to happen in the first place. If you encountered
    a problem with specific files of any sorts, make sure to also include a link to a file
    with which to reproduce the problem.]

#### What did you expect to happen?

#### What happened instead?

#### Branch & Commit or Version of Smoothieware

    [Can be found with the version command. (@version in pronterface)]

#### Hardware model you are using (Make, and version)

    [eg Smoothieboard 5X V1b, Azteeg X5 Mini V2, ... etc]

#### Host and Operating System running the Host

    [eg Pronterface, Octoprint, linux x64]

#### Link to and console logs

    [On gist.github.com or pastebin.com. Always include and never truncate.]
    
#### Link to running config and M503 results

    [On gist.github.com or pastebin.com. Always include and never truncate.]

I have read the [Wiki](http://smoothieware.org) and Especially the [Trouble Shooting section](http://smoothieware.org/troubleshooting)... 

Copy-paste this template **completely**. Do not skip any lines!

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