From 8b2074e8084f21d131654ae420f6df23ae5126da Mon Sep 17 00:00:00 2001 From: 3d-gussner <3d.gussner@gmail.com> Date: Wed, 14 Aug 2024 10:40:31 +0200 Subject: [PATCH 1/5] New github issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 34 -------- .github/ISSUE_TEMPLATE/bug_report.yml | 96 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/community.md | 17 ---- .github/ISSUE_TEMPLATE/community.yml | 25 ++++++ .github/ISSUE_TEMPLATE/config.yml | 11 +++ .github/ISSUE_TEMPLATE/enhancement.md | 20 ----- .github/ISSUE_TEMPLATE/enhancement.yml | 36 ++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ----- .github/ISSUE_TEMPLATE/feature_request.yml | 36 ++++++++ .github/ISSUE_TEMPLATE/question.md | 12 --- .github/ISSUE_TEMPLATE/question.yml | 16 ++++ 11 files changed, 220 insertions(+), 103 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/community.md create mode 100644 .github/ISSUE_TEMPLATE/community.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/enhancement.md create mode 100644 .github/ISSUE_TEMPLATE/enhancement.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index bac4ae5a9..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[BUG]" -labels: bug -assignees: '' - ---- - -**Printer type** - [e.g. MK3S, MK3, MK2.5S, MK2.5, MK2S, MK2] -**Printer firmware version** - [e.g. 3.8.1, 3.8.1-RC1, ...] - -**MMU upgrade** - [e.g. MMU2S, MMU2, MMU1] -**MMU upgrade firmware version** - [e.g. 1.0.6, 1.0.6-RC2, ...] - -**SD card or USB/Octoprint** - Please let us know if you print via SD card or USB/Octoprint - -**Describe the bug** - A clear and concise description of what the bug is. - -**To Reproduce** - Please describe steps to reproduce the behavior. - -**Expected behavior** - A clear and concise description of what you expected to happen. - -**G-code** - Please attach a G-code. This will make it easier for us to replicate the error. - -**Video** - Please attach a video. It usually helps to solve the problem. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..2fa16890f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,96 @@ +name: Bug report +description: File a bug report +title: '[BUG] ' +labels: + - bug +body: + - type: markdown + attributes: + value: | + Before you create a new bug report, please check if an issue with it already exists (either open or closed) by using the search bar on the issues page. If it does, comment there. Even if it's closed, we can reopen it based on your comment. + - type: dropdown + id: printer_model + attributes: + label: Printer model + description: Enter the printer model(s) where you encountered the issue + placeholder: 'MK3S/+, MK3, Mk2.5S, MK2.5' + options: + - MK3S/+ + - MK3 + - MK2.5S + - MK2.5 + validations: + required: true + - type: dropdown + id: mmu_model + attributes: + label: MMU model + description: Enter the MMU model(s) where you encountered the issue + placeholder: 'MMU3, MMU2S' + options: + - MMU3 + - MMU2S + - None + validations: + required: true + - type: input + id: firmware_version + attributes: + label: Firmware version + description: | + If you're using a custom firmware (not downloaded from Prusa), please note that! + placeholder: '3.14.0, 3.12.0-RC1, 3.14.0 and 3.0.2...' + validations: + required: true + - type: input + id: optional_upgrades + attributes: + label: Upgrades and modifications + description: 'If your printer has upgrades or was modified, please note that! If not, please write None or leave blank.' + placeholder: | + None, filament runout sensor (Mini), custom extruder/hotend (which), ... + - type: dropdown + id: printing_from + attributes: + label: Printing from... + options: + - SD Card + - PrusaLink + - PrusaConnect + - OctoPrint + - Other host software + validations: + required: true + - type: textarea + id: description + attributes: + label: Describe the bug + description: Write a concise description of the bug. + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: How to reproduce + description: | + If you are able to reproduce the issue - meaning that you can trigger it yourself by following certain steps - please describe the step-by-step process in as much detail as possible! + - type: textarea + id: expected_behavior + attributes: + label: Expected behavior + description: | + If the printer did something unexpected, or if the procedure is missing a step that would resolve the issue, please provide a step-by-step process of how it should behave. + - type: textarea + id: files + attributes: + label: Files + description: | + Provide at least one of these (ideally as many as you can) to help developers track down the bug. + *To upload files, compress them into a .zip file and drag them to the text area to upload.* Images and videos can be uploaded directly. + + - **gcode** file + - **3mf project** which includes the model and printer settings + - **video** or **photos** of the issue happening + + **Crash dump: Do not share the file publicly**, as the crash dump contains a raw snapshot of the printer's memory and may include unencrypted sensitive information. + Please send the crash dump file to Prusa by emailing it to reports@prusa3d.com and referencing this issue. Sharing this file is important and helps us investigate the bug. diff --git a/.github/ISSUE_TEMPLATE/community.md b/.github/ISSUE_TEMPLATE/community.md deleted file mode 100644 index a2d69a2d3..000000000 --- a/.github/ISSUE_TEMPLATE/community.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Community -about: Related to "Community made" features -title: "[Community made] " -labels: community_made -assignees: '' - ---- - -Prusa Research will NOT follow up these issues! -The maintainers of the "Community made" feature should/will react. - -Please, before you create a new "Community made" ticket, please make sure you searched in open and closed issues and couldn't find anything that matches. - -**Which Community made feature do you want to address?** - -**What is your request/question/suggestion?** diff --git a/.github/ISSUE_TEMPLATE/community.yml b/.github/ISSUE_TEMPLATE/community.yml new file mode 100644 index 000000000..51e791a92 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/community.yml @@ -0,0 +1,25 @@ +name: Community +description: Related to "Community made" features +title: '[Community made] ' +labels: + - community_made +body: + - type: markdown + attributes: + value: > + Prusa Research will NOT follow up these issues! + The maintainers of the "Community made" feature should/will react. + + Please, before you create a new "Community made" ticket, please make sure you searched in open and closed issues and couldn't find anything that matches. + - type: textarea + id: which_community + attributes: + label: Which Community made feature do you want to address? + validations: + required: true + - type: textarea + id: What_about_community + attributes: + label: What is your request/question/suggestion? + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..1d2a71bfc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +contact_links: + - name: Do you need Support? + url: https://help.prusa3d.com/article/customer-support_2287 + about: If you are not sure whether what you are reporting is a bug, please contact our support team first. We are providing full 24/7 customer support. + - name: Knowledge Base + url: https://help.prusa3d.com/ + about: We have a comprehensive help documentation that could be helpful for troubleshooting. + - name: Prusa Forum + url: https://forum.prusa3d.com/ + about: Please get in touch on our Prusa Forum! (Not an official support channel) +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md deleted file mode 100644 index 96b6e5de0..000000000 --- a/.github/ISSUE_TEMPLATE/enhancement.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Enhancement -about: Suggest an idea for this project -title: " [ENHANCEMENT]" -labels: enhancement -assignees: '' - ---- - -Please, before you create a new feature request, please make sure you searched in open and closed issues and couldn't find anything that matches. - -Enter what type of printer or upgrade the enhancement applies to. -**Printer type** - [e.g. MK3S, MK3, MK2.5S, MK2.5, MK2S, MK2] -**MMU Upgrade** - [e.g. MMU2S, MMU2, MMU1] - -**Is your enhancement 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. diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml new file mode 100644 index 000000000..08f1a68dc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -0,0 +1,36 @@ +name: Enhancement +description: Suggest an improvement of the existing functionality +title: '[ENHANCEMENT] ' +labels: + - enhancement +body: + - type: markdown + attributes: + value: | + Before you create a new enhancement, please check if an issue with it already exists (either open or closed) by using the search bar on the issues page. + - type: checkboxes + id: printer_model + attributes: + label: Printer model + description: Enter the printer model(s) where you would like this enhancement + placeholder: 'MK3S/+, MK3, MK2.5S, MK2.5' + options: + - MK3S/+ + - MK3 + - MK2.5S + - MK2.5 + validations: + required: true + - type: textarea + id: description + attributes: + label: Describe the enhancement + description: How would this enhancement improve your experience? Do you have a specific use case where this enhancemnet is especially needed? + validations: + required: true + - type: textarea + id: expected_functionality + attributes: + label: Expected functionality + description: | + Describe the way the enhancement would change existing functionality. You can also describe it in a step-by-step basis if applicable. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index a9fd99c29..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "[FEATURE REQUEST]" -labels: feature request -assignees: '' - ---- - -Please, before you create a new feature request, please make sure you searched in open and closed issues and couldn't find anything that matches. - -If it makes sense, enter what type of printer or upgrade the feature request applies to. -**Printer type** - [e.g. MK3S, MK3, MK2.5S, MK2.5, MK2S, MK2] -**MMU Upgrade** - [e.g. MMU2S, MMU2, MMU1] - -**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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..96ff72810 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,36 @@ +name: Feature request +description: Suggest new functionality +title: '[FEATURE REQUEST] ' +labels: + - feature request +body: + - type: markdown + attributes: + value: | + Before you create a new feature request, please check if an issue with it already exists (either open or closed) by using the search bar on the issues page. + - type: checkboxes + id: printer_model + attributes: + label: Printer model + description: Enter the printer model(s) where you would like this feature + placeholder: 'MK3S/+, MK3, MK2.5S, MK2.5' + options: + - MK3S/+ + - MK3 + - MK2.5S + - MK2.5 + validations: + required: true + - type: textarea + id: description + attributes: + label: Describe the feature + description: How would this feature improve the printer? Are there specific use cases where this would be beneficial? Describe how you would use it. + validations: + required: true + - type: textarea + id: expected_functionality + attributes: + label: Expected functionality + description: | + Describe the way the feature would work. You can also describe it in a step-by-step basis if applicable. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 14ce734fe..000000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -name: Question -about: What do you want to know? -title: "[QUESTION]" -labels: question -assignees: '' - ---- - -Please, before you create a new question, please make sure you searched in open and closed issues and couldn't find anything that matches. - -**What is your question?** diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 000000000..517f4aa3c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,16 @@ +name: Question +description: Ask a firmware specific question +title: '[QUESTION] ' +labels: + - question +body: + - type: markdown + attributes: + value: | + Before you create a new question, please check if an issue with it already exists (either open or closed) by using the search bar on the issues page. + - type: textarea + id: question + attributes: + label: Question + validations: + required: true From be6c85cf0c7393dbee96952225f8cd84806d8e42 Mon Sep 17 00:00:00 2001 From: 3d-gussner <3d.gussner@gmail.com> Date: Wed, 14 Aug 2024 11:04:39 +0200 Subject: [PATCH 2/5] Fix syntax --- .github/ISSUE_TEMPLATE/bug_report.yml | 34 +++++++++++----------- .github/ISSUE_TEMPLATE/enhancement.yml | 10 +++---- .github/ISSUE_TEMPLATE/feature_request.yml | 10 +++---- 3 files changed, 27 insertions(+), 27 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 2fa16890f..ee99333a6 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -13,12 +13,11 @@ body: attributes: label: Printer model description: Enter the printer model(s) where you encountered the issue - placeholder: 'MK3S/+, MK3, Mk2.5S, MK2.5' - options: - - MK3S/+ - - MK3 - - MK2.5S - - MK2.5 + options: + - MK3S/+ + - MK3 + - MK2.5S + - MK2.5 validations: required: true - type: dropdown @@ -26,11 +25,11 @@ body: attributes: label: MMU model description: Enter the MMU model(s) where you encountered the issue - placeholder: 'MMU3, MMU2S' - options: - - MMU3 - - MMU2S - - None + multiple: false + options: + - MMU3 + - MMU2S + - No-MMU validations: required: true - type: input @@ -53,12 +52,13 @@ body: id: printing_from attributes: label: Printing from... - options: - - SD Card - - PrusaLink - - PrusaConnect - - OctoPrint - - Other host software + multiple: false + options: + - SD Card + - PrusaLink + - PrusaConnect + - OctoPrint + - Other host software validations: required: true - type: textarea diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml index 08f1a68dc..390065060 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.yml +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -14,11 +14,11 @@ body: label: Printer model description: Enter the printer model(s) where you would like this enhancement placeholder: 'MK3S/+, MK3, MK2.5S, MK2.5' - options: - - MK3S/+ - - MK3 - - MK2.5S - - MK2.5 + options: + - MK3S/+ + - MK3 + - MK2.5S + - MK2.5 validations: required: true - type: textarea diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 96ff72810..22029ce87 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -14,11 +14,11 @@ body: label: Printer model description: Enter the printer model(s) where you would like this feature placeholder: 'MK3S/+, MK3, MK2.5S, MK2.5' - options: - - MK3S/+ - - MK3 - - MK2.5S - - MK2.5 + options: + - MK3S/+ + - MK3 + - MK2.5S + - MK2.5 validations: required: true - type: textarea From dad1e4081ee881820a1b2941ecbbf2bb799a012c Mon Sep 17 00:00:00 2001 From: 3d-gussner <3d.gussner@gmail.com> Date: Wed, 14 Aug 2024 11:08:47 +0200 Subject: [PATCH 3/5] Fix more syntax issues --- .github/ISSUE_TEMPLATE/enhancement.yml | 1 - .github/ISSUE_TEMPLATE/feature_request.yml | 1 - 2 files changed, 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml index 390065060..0ce617ad6 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.yml +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -13,7 +13,6 @@ body: attributes: label: Printer model description: Enter the printer model(s) where you would like this enhancement - placeholder: 'MK3S/+, MK3, MK2.5S, MK2.5' options: - MK3S/+ - MK3 diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 22029ce87..662073b58 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -13,7 +13,6 @@ body: attributes: label: Printer model description: Enter the printer model(s) where you would like this feature - placeholder: 'MK3S/+, MK3, MK2.5S, MK2.5' options: - MK3S/+ - MK3 From 2f9dafcf97ac55b86dfb2840da8e7bf43f02e0ab Mon Sep 17 00:00:00 2001 From: 3d-gussner <3d.gussner@gmail.com> Date: Wed, 14 Aug 2024 11:16:49 +0200 Subject: [PATCH 4/5] Fix even more syntax --- .github/ISSUE_TEMPLATE/enhancement.yml | 8 ++++---- .github/ISSUE_TEMPLATE/feature_request.yml | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml index 0ce617ad6..163118246 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.yml +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -14,10 +14,10 @@ body: label: Printer model description: Enter the printer model(s) where you would like this enhancement options: - - MK3S/+ - - MK3 - - MK2.5S - - MK2.5 + - label: MK3S/+ + - label: MK3 + - label: MK2.5S + - label: MK2.5 validations: required: true - type: textarea diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 662073b58..8bd203338 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -14,10 +14,10 @@ body: label: Printer model description: Enter the printer model(s) where you would like this feature options: - - MK3S/+ - - MK3 - - MK2.5S - - MK2.5 + - label: MK3S/+ + - label: MK3 + - label: MK2.5S + - label: MK2.5 validations: required: true - type: textarea From 0e84d0bb41859cf8fc0f2d5c6849314b0c004c78 Mon Sep 17 00:00:00 2001 From: 3d-gussner <3d.gussner@gmail.com> Date: Thu, 22 Aug 2024 14:45:15 +0200 Subject: [PATCH 5/5] Update some text --- .github/ISSUE_TEMPLATE/bug_report.yml | 8 ++++---- .github/ISSUE_TEMPLATE/enhancement.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index ee99333a6..68b97994b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -27,15 +27,15 @@ body: description: Enter the MMU model(s) where you encountered the issue multiple: false options: + - No-MMU - MMU3 - MMU2S - - No-MMU validations: required: true - type: input id: firmware_version attributes: - label: Firmware version + label: Firmware versions description: | If you're using a custom firmware (not downloaded from Prusa), please note that! placeholder: '3.14.0, 3.12.0-RC1, 3.14.0 and 3.0.2...' @@ -47,7 +47,7 @@ body: label: Upgrades and modifications description: 'If your printer has upgrades or was modified, please note that! If not, please write None or leave blank.' placeholder: | - None, filament runout sensor (Mini), custom extruder/hotend (which), ... + None, custom extruder/hotend (which), different frame, ... - type: dropdown id: printing_from attributes: @@ -93,4 +93,4 @@ body: - **video** or **photos** of the issue happening **Crash dump: Do not share the file publicly**, as the crash dump contains a raw snapshot of the printer's memory and may include unencrypted sensitive information. - Please send the crash dump file to Prusa by emailing it to reports@prusa3d.com and referencing this issue. Sharing this file is important and helps us investigate the bug. + Please send the crash dump file to Prusa by emailing it to reports@prusa3d.com and referencing this issue. In reply to the email, you will be automatically assigned a reference code to be mentioned in the issue. Sharing this file is important and helps us investigate the bug. diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml index 163118246..f5dd83553 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.yml +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -12,7 +12,7 @@ body: id: printer_model attributes: label: Printer model - description: Enter the printer model(s) where you would like this enhancement + description: Select the printer model(s) where you would like this enhancement options: - label: MK3S/+ - label: MK3 diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 8bd203338..0be75d96d 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -12,7 +12,7 @@ body: id: printer_model attributes: label: Printer model - description: Enter the printer model(s) where you would like this feature + description: Select the printer model(s) where you would like this feature options: - label: MK3S/+ - label: MK3