Browse Source

Give a more detailed issue template

Scott Lahteine 7 years ago
parent
commit
a18324bc8d
1 changed files with 33 additions and 4 deletions
  1. 33
    4
      .github/issue_template.md

+ 33
- 4
.github/issue_template.md View File

@@ -1,7 +1,36 @@
1
-### Expected behaviour
1
+Thank you for submitting your feedback to the Marlin project.
2
+Please use one of the templates below to fill out this box.
2 3
 
3
-### Actual behaviour
4
+------------------------------------------------------------
5
+### Feature Request
6
+Please put [FR] in the issue title: `[FR] Add-on that goes 'ping'`
4 7
 
5
-### Steps to reproduce the behaviour
8
+------------------------------------------------------------
9
+### Compile Error
10
+When I compile with `FEATURE_X` I get an error:
11
+```
12
+Paste_the_error_text_here
13
+```
6 14
 
7
-#### please add your Configuration.h and Configuration_adv.h to a zip file and attach it to this issue
15
+------------------------------------------------------------
16
+### Bug Report
17
+- Description: ---
18
+- Expected behaviour: ---
19
+- Actual behaviour: ---
20
+- Steps to reproduce:
21
+  - Do this
22
+  - Do that
23
+
24
+Attach a ZIP of `Configuration.h` and `Configuration_adv.h` by dropping here.
25
+
26
+------------------------------------------------------------
27
+### Bug Report Tips
28
+- When troubleshooting, use `M502` followed by `M500` to reset EEPROM to defaults.
29
+- Use `DEBUG_LEVELING_FEATURE` with `M111 S247` for detailed logging of homing/leveling.
30
+- Format text with: **bold**, _italic_, `code`.
31
+- Format C++ with three backticks, plus "cpp":
32
+```cpp
33
+void my_function(bool do_it) {
34
+  // Hold this spot
35
+}
36
+```

Loading…
Cancel
Save