Browse Source

Update "Bug Report" template (#19906)

Jason Smith 3 years ago
parent
commit
ee7476a0bf
No account linked to committer's email address
1 changed files with 26 additions and 10 deletions
  1. 26
    10
      .github/ISSUE_TEMPLATE/bug_report.md

+ 26
- 10
.github/ISSUE_TEMPLATE/bug_report.md View File

@@ -9,35 +9,51 @@ assignees: ''
9 9
 
10 10
 <!--
11 11
 
12
-Have you read Marlin's Code of Conduct? By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/MarlinFirmware/Marlin/blob/master/.github/code_of_conduct.md
12
+Please follow the instructions below. Failure to do so may result in your issue being closed.
13 13
 
14
-Do you want to ask a question? Are you looking for support? Please don't post here. Instead please use one of the support links at https://github.com/MarlinFirmware/Marlin/issues/new/choose
14
+### Before Reporting a Bug
15 15
 
16
-Before filing an issue be sure to test the "bugfix" branches to see whether the issue has been resolved.
16
+1. Test with the `bugfix-2.0.x` branch to see whether the issue still exists.
17
+
18
+2. Get troubleshooting help from the Marlin community to confirm it's a bug and not just a configuration error. Links at https://github.com/MarlinFirmware/Marlin/issues/new/choose
19
+
20
+### Instructions
21
+
22
+1. Fill out every section of the template below.
23
+
24
+2. Always attach configuration files, regardless of whether you think they are involved.
25
+
26
+3. Read and understand Marlin's Code of Conduct. By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/MarlinFirmware/Marlin/blob/master/.github/code_of_conduct.md
17 27
 
18 28
 -->
19 29
 
20 30
 ### Bug Description
21 31
 
22
-<!-- Description of the bug -->
32
+<!-- Describe the bug in this section. (You can remove this invisible comment.) -->
33
+
34
+### Configuration Files
23 35
 
24
-### My Configurations
36
+**Required:** Include a ZIP file containing `Configuration.h` and `Configuration_adv.h`.
25 37
 
26
-**Required:** Please include a ZIP file containing your `Configuration.h` and `Configuration_adv.h` files.
38
+If you've made any other modifications describe them in detail here.
27 39
 
28 40
 ### Steps to Reproduce
29 41
 
30
-<!-- Please describe the steps needed to reproduce the issue -->
42
+<!-- Describe the steps needed to reproduce the issue. (You can remove this invisible comment.) -->
31 43
 
32 44
 1. [First Step]
33 45
 2. [Second Step]
34 46
 3. [and so on...]
35 47
 
36
-**Expected behavior:** [What you expect to happen]
48
+**Expected behavior:**
49
+
50
+<!-- Describe what you expected to happen here. (You can remove this invisible comment.) -->
51
+
52
+**Actual behavior:**
37 53
 
38
-**Actual behavior:** [What actually happens]
54
+<!-- Describe what actually happens here. (You can remove this invisible comment.) -->
39 55
 
40 56
 #### Additional Information
41 57
 
42 58
 * Provide pictures or links to videos that clearly demonstrate the issue.
43
-* See [How Can I Contribute](#how-can-i-contribute) for additional guidelines.
59
+* See [Contributing to Marlin](https://github.com/MarlinFirmware/Marlin/blob/2.0.x/.github/contributing.md) for additional guidelines.

Loading…
Cancel
Save