From 95b79356fc2d9f44c085159d5663e72fd8d16665 Mon Sep 17 00:00:00 2001 From: Davide Bortolami Date: Sat, 18 Jan 2025 02:17:05 +0000 Subject: [PATCH 1/3] delete old stale issue template --- .github/ISSUE_TEMPLATE.md | 27 --------------------------- 1 file changed, 27 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index dbf3c76dc3c..00000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,27 +0,0 @@ -### Version -_Version of PrusaSlicer used goes here_ - -_Use `About->About PrusaSlicer` for release versions_ - -_For -dev versions, use `git describe --tag` or get the hash value for the version you downloaded or `git rev-parse HEAD`_ - -### Operating system type + version -_What OS are you using, and state any version #s_ -_In case of 3D rendering issues, please attach the content of menu Help -> System Info dialog_ - -### 3D printer brand / version + firmware version (if known) -_What 3D printer brand / version are you printing on, is it a stock model or did you modify the printer, what firmware is running on your printer, version of the firmware #s_ - -### Behavior -* _Describe the problem_ -* _Steps needed to reproduce the problem_ - * _If this is a command-line slicing issue, include the options used_ -* _Expected Results_ -* _Actual Results_ - * _Screenshots from __*PrusaSlicer*__ preview are preferred_ - -_Is this a new feature request?_ - -#### Project File (.3MF) where problem occurs -_Upload a PrusaSlicer Project File (.3MF) (`Plater -> Export plate as 3MF` for Slic3r PE 1.41.2 and older, `File -> Save` / `Save Project` for PrusaSlicer, Slic3r PE 1.42.0-alpha and newer)_ -_Images (PNG, GIF, JPEG), PDFs or text files could be drag & dropped to the issue directly, while all other files need to be zipped first (.zip, .gz)_ From 1c8c5bb3fe1f758d1b7260ae34a7add43ab8ee39 Mon Sep 17 00:00:00 2001 From: Davide Bortolami Date: Sat, 18 Jan 2025 02:24:45 +0000 Subject: [PATCH 2/3] update bug form template to new yml form format, including auto-labeling. --- .github/ISSUE_TEMPLATE/bug_report_form.yml | 72 +++++++++++++--------- 1 file changed, 42 insertions(+), 30 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report_form.yml b/.github/ISSUE_TEMPLATE/bug_report_form.yml index cb355444735..7242bc1d632 100644 --- a/.github/ISSUE_TEMPLATE/bug_report_form.yml +++ b/.github/ISSUE_TEMPLATE/bug_report_form.yml @@ -1,65 +1,77 @@ name: Bug Report description: File a bug report +labels: ["bug"] body: - type: markdown attributes: value: | - Before filing, please check if the issue 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. + Before submitting a new issue, please search both open and closed issues to check if this has been reported before. If you find a similar issue, please add your information as a comment on the existing issue instead of creating a new one. We can reopen closed issues if needed. + - type: textarea id: what-happened attributes: - label: Description of the bug - description: What happened? Please, enclose a screenshot whenever possible (even when you think the description is clear). What did you expect to happen? In case of 3D rendering issues, please attach the content of menu Help -> System Info dialog. + label: Bug Description + description: | + Please describe what happened and what you expected to happen instead. + Include screenshots whenever possible, even if the issue seems clear. + For 3D rendering issues, please include the output from Help -> System Info. placeholder: | - What is the problem? - What did you expect? - You paste or drop screenshots here + • What is the problem you encountered? + • What did you expect to happen instead? + • Drop any relevant screenshots here validations: required: true + - type: textarea id: to_reproduce attributes: - label: Project file & How to reproduce - description: "*Please* upload a ZIP archive containing the project file used when the problem arise. Please export it just before the problem occurs. Even if you did nothing and/or there is no object, export it! (it contains your current configuration)." + label: Project File & Reproduction Steps + description: | + Please upload your project file as a ZIP archive. Export it right before the issue occurs, even if the project is empty - this helps us see your configuration. + + To export: File -> Save project as... -> Create ZIP placeholder: | - `File`->`Save project as...` then zip it & drop it here - Also, if needed include the steps to reproduce the bug: - 1. Go to '...' - 2. Click on '....' - 3. Scroll down to '....' - 4. See error + 1. Drop your project ZIP file here + 2. List the steps to reproduce the issue: + • Open PrusaSlicer + • Click on... + • etc. validations: required: true + - type: checkboxes + id: files-included attributes: - label: Checklist of files included above + label: Submission Checklist options: - - label: Project file - - label: Screenshot - validations: - required: true + - label: I have attached the project file + required: true + - label: I have included relevant screenshots + required: true + - type: input id: version attributes: - label: Version of PrusaSlicer - description: What version of PrusaSlicer are you running? You can see the full version in `Help` -> `About PrusaSlicer`. - placeholder: e.g. 2.4.1-alpha2-win64 / 2.3.3-linux / 2.4.1-alpha0+61-win64-gcd2459455 ... + label: PrusaSlicer Version + description: Check Help -> About PrusaSlicer for your exact version number + placeholder: 2.4.1-alpha2-win64, 2.3.3-linux, 2.4.1-alpha0+61-win64-gcd2459455 validations: required: true + - type: input id: os attributes: - label: Operating system - description: with the version if possible - placeholder: e.g. Windows 7/8/10/11 ... , Ubuntu 22.04/Debian ... , macOS 10.15/11.1 ... + label: Operating System + description: Please include your OS version + placeholder: Windows 11, Ubuntu 22.04, macOS 13.1 validations: required: true + - type: input id: printer attributes: - label: Printer model - description: Please, fill this in even when it seems irrelevant. - placeholder: voron 2.4 with afterburner + label: Printer Model + description: Please specify your printer model (required even if the issue seems unrelated) + placeholder: Voron 2.4 with Afterburner validations: - required: true - + required: true \ No newline at end of file From d99ba04136446a7d47d462a78cd42b37a8b1b06d Mon Sep 17 00:00:00 2001 From: Davide Bortolami Date: Sat, 18 Jan 2025 02:25:15 +0000 Subject: [PATCH 3/3] improve feature request form, correct the english, autolabel as feature request. --- .github/ISSUE_TEMPLATE/feature_request.md | 20 --------- .github/ISSUE_TEMPLATE/feature_request.yml | 51 ++++++++++++++++++++++ 2 files changed, 51 insertions(+), 20 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index aed18468720..00000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project - ---- - -**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 how it would work** -Be as descriptive as your skill level allows you. - -**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 paint drawing about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000000..dafb9a0ed3a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,51 @@ +name: Feature request +description: Suggest an idea for this project +labels: ["feature request"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this feature request! + + - type: textarea + id: problem + attributes: + label: Is your feature request related to a problem? + description: A clear and concise description of what the problem is. + placeholder: I'm always frustrated when [...] + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + validations: + required: true + + - type: textarea + id: implementation + attributes: + label: Describe how it would work + description: Be as descriptive as your skill level allows you. + placeholder: Explain the technical implementation you're imagining + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false + + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. + placeholder: You can attach images by dragging and dropping them here + validations: + required: false \ No newline at end of file