From a18324bc8d40de50a4f407085ede7a1a8e7a0028 Mon Sep 17 00:00:00 2001 From: Scott Lahteine Date: Thu, 22 Jun 2017 18:00:01 -0500 Subject: [PATCH] Give a more detailed issue template --- .github/issue_template.md | 37 +++++++++++++++++++++++++++++++++---- 1 file changed, 33 insertions(+), 4 deletions(-) diff --git a/.github/issue_template.md b/.github/issue_template.md index 8be2b3e99..17f680d57 100644 --- a/.github/issue_template.md +++ b/.github/issue_template.md @@ -1,7 +1,36 @@ -### Expected behaviour +Thank you for submitting your feedback to the Marlin project. +Please use one of the templates below to fill out this box. -### Actual behaviour +------------------------------------------------------------ +### Feature Request +Please put [FR] in the issue title: `[FR] Add-on that goes 'ping'` -### Steps to reproduce the behaviour +------------------------------------------------------------ +### Compile Error +When I compile with `FEATURE_X` I get an error: +``` +Paste_the_error_text_here +``` -#### please add your Configuration.h and Configuration_adv.h to a zip file and attach it to this issue +------------------------------------------------------------ +### Bug Report +- Description: --- +- Expected behaviour: --- +- Actual behaviour: --- +- Steps to reproduce: + - Do this + - Do that + +Attach a ZIP of `Configuration.h` and `Configuration_adv.h` by dropping here. + +------------------------------------------------------------ +### Bug Report Tips +- When troubleshooting, use `M502` followed by `M500` to reset EEPROM to defaults. +- Use `DEBUG_LEVELING_FEATURE` with `M111 S247` for detailed logging of homing/leveling. +- Format text with: **bold**, _italic_, `code`. +- Format C++ with three backticks, plus "cpp": +```cpp +void my_function(bool do_it) { + // Hold this spot +} +```