From fe4cf8e8187c22226a47bc11c509fff4e311c62c Mon Sep 17 00:00:00 2001 From: Julien Staub Date: Sun, 8 May 2022 11:35:51 +0200 Subject: [PATCH] better feature request template (#751) * better feature request template * bug template improved --- .../ISSUE_TEMPLATE/bug-report---problem.md | 51 +++++++++++-------- .github/ISSUE_TEMPLATE/feature_request.md | 12 +++-- 2 files changed, 37 insertions(+), 26 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report---problem.md b/.github/ISSUE_TEMPLATE/bug-report---problem.md index 5be6778d..b63104d7 100644 --- a/.github/ISSUE_TEMPLATE/bug-report---problem.md +++ b/.github/ISSUE_TEMPLATE/bug-report---problem.md @@ -8,44 +8,51 @@ assignees: '' --- **Describe the bug** -A clear and concise description of what the bug is. + + **To Reproduce** -Steps to reproduce the behavior: + + 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error **Expected behavior** -A clear and concise description of what you expected to happen. + + **Screenshots** -If applicable, add screenshots to help explain your problem. + + **ESP3D Firmware:** -- ESP core version: [2.5.2] -- Version:[e.g 2.1b4] -- Web UI Version:[e.g 2.1b14] -- Wifi mode:[e.g. STA] -- Flash method: [Arduino Ide / PlatformIO] -- Any change done in FW - - tips: to get ESP3D informations type `[ESP420]plain` - to get WebUI version check your menu header + + +- ESP core version: [e.g. 2.5.2] +- Version:[e.g. 2.1b4] +- Web UI Version:[e.g. 2.1b14] +- Wifi mode:[e.g. STA/AP] +- Flash method: [Arduino Ide / PlatformIO] +- Any change done in FW: **Target Firmware:** - - Name: [e.g. Marlin] - - Version [e.g. 2.0] - - tip: to get firmware info type `M115` in console + + +- Name: [e.g. Marlin] +- Version [e.g. 2.0] **Board used (please complete the following information):** - - MCU: [e.g. ESP32] - - Name:[e.g. NodeMCU2s] - - Flash size: [e.g. 4M: 2M/2M] + +- MCU:[e.g. ESP32] +- Name:[e.g. NodeMCU2s] +- Flash size: [e.g. 4M: 2M/2M] **Additional context** -Add any other context about the problem here. -Wiring, decoded stack, etc... + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 0d89f881..6ad494b9 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -8,13 +8,17 @@ assignees: '' --- **Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + + **Describe the solution you'd like** -A clear and concise description of what you want to happen. + + **Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. + + **Additional context** -Add any other context or screenshots about the feature request here. + +