From 7ac9aa5f906d1c7c99e9a4eb7ed1867cd40afd55 Mon Sep 17 00:00:00 2001 From: "lane.wei" Date: Wed, 24 May 2023 11:10:32 +0800 Subject: [PATCH] ENH: refine the bug report format on github --- .github/ISSUE_TEMPLATE/bug_report.yml | 120 +++++++++++++++++--------- 1 file changed, 81 insertions(+), 39 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 0f24e898d..04d0c0fcb 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,72 +1,114 @@ name: Bug Report description: File a bug report -labels: bug +labels: Bug body: - type: markdown attributes: value: | + **Thank you for using Bambu Studio and wanting to report a bug.** 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. - - type: textarea - id: what-happened + - type: input + id: version 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? + label: Bambu Studio Version + description: Which version of Bambu Studio are you running? You can see the full version in `Help` -> `About Bambu Studio`. + placeholder: e.g. 1.6.2.4 + validations: + required: true + - type: dropdown + id: app_from + attributes: + label: Where is the application from? + description: please confirm where is your Bambu Studio from + multiple: true + options: + - Bambu Lab Official website + - Bambu Lab github releases + - Built from source by yourself or others + validations: + required: true + - type: input + id: os_info + attributes: + label: OS version + description: Which OS version are you using? placeholder: | - What is the problem? - What did you expect? - Paste or drop screenshots here + OS: Windows 7/8/10/11 ... , Ubuntu 22.04/Fedora 36 ... , macOS 10.15/11.1/12.3 ... validations: required: true - type: textarea - id: to_reproduce + id: system_info 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 or after the problem occurs. Even if you did nothing and/or there is no object, export it! (We need the configurations in project file)." + label: Additional system information + description: For the performance issue, please also show the CPU、Memory information; For the 3D Rendering issue, please also show the Display Card information. + placeholder: | + CPU: 11th gen intel r core tm i7-1185g7/amd ryzen 7 6800h/... + Memory: 32/16 GB... + Display Card: NVIDIA Quadro P400/... + validations: + required: false + - type: input + id: printer + attributes: + label: Printer + description: Which printer was selected + placeholder: Bambu Lab X1 series/Bambu Lab P1P/... + validations: + required: true + - type: textarea + id: reproduce_steps + attributes: + label: How to reproduce + description: Please described the detailed steps to reproduce this issue 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 validations: required: true - - type: input - id: version + - type: textarea + id: actual_results attributes: - label: Version - description: Which version of Bambu Studio are you running? You can see the full version in `Help` -> `About Bambu Studio`. - placeholder: e.g. Bambu Studio 1.6.2.4 + label: Actual results + description: What happens after the above steps? Please, enclose a screenshot whenever possible (even when you think the description is clear). validations: required: true - type: textarea - id: system_info + id: expected_results attributes: - label: System Information - description: Which OS version are you using? For the performance issue, please also show the CPU、Memory information; For the 3D Rendering issue, please also show the Display Card information. - placeholder: | - OS: Windows 7/8/10/11 ... , Ubuntu 22.04/Fedora 36 ... , macOS 10.15/11.1/12.3 ... - CPU: 11th gen intel r core tm i7-1185g7/amd ryzen 7 6800h/... - Memory: 32/16 GB... - Display Card: NVIDIA Quadro P400/... + label: Expected results + description: What should happen after the above steps? validations: required: true - - type: input - id: printer + - type: markdown + id: file_required attributes: - label: Printer model - description: Please, fill this in even when it seems irrelevant. - placeholder: Bambu Lab X1 Carbon - validations: - required: true + value: | + Please be sure to add the following files: + * Please upload a ZIP archive containing the **project file** used when the problem arise. Please export it just before or after the problem occurs. Even if you did nothing and/or there is no object, export it! (We need the configurations in project file). + You can export the project file from the application menu in `File`->`Save project as...`, then zip it + * A **log file** for crashes and similar issues. + You can find your log file here: + Windows: `%APPDATA%\BambuStudio\log` or usually `C:\Users\\\AppData\Roaming\BambuStudio\log` + MacOS: `$USER/Library/Application Support/BambuStudio/log` + Linux: `$USER/.config/BambuStudio/log + If the Cura user interface still starts, you can also reach this directory from the application menu in `Help` -> `Show Configuration Folder` + You can zip the log directory, or just select the newest logs when this issue happens, and zip them - type: textarea - id: app_from + id: file_uploads attributes: - label: Where is the application from? - description: please confirm where is your Bambu Studio from + label: Project file & Debug log uploads + description: Drop the project file and debug log here placeholder: | - e.g. Bambu Lab Official website, Bambu Lab github releases, OTA upgrading(popup box in Bambu Studio) - e.g. Built from source + Project File: `File`->`Save project as...` then zip it & drop it here + Log File: `Help` -> `Show Configuration Folder`, then zip the log directory, or just select the newest logs in `log` when this issue happens and zip them, then drop the zip file here validations: required: true - + - type: checkboxes + id: file_checklist + attributes: + label: Checklist of files to include + options: + - label: Log file + - label: Project file