ENH: refine the bug report format on github

This commit is contained in:
lane.wei 2023-05-24 11:10:32 +08:00 committed by Lane.Wei
parent 2ee65e8bde
commit 7ac9aa5f90

View File

@ -1,72 +1,114 @@
name: Bug Report name: Bug Report
description: File a bug report description: File a bug report
labels: bug labels: Bug
body: body:
- type: markdown - type: markdown
attributes: attributes:
value: | 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. 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 - type: input
id: what-happened id: version
attributes: attributes:
label: Description of the bug label: Bambu Studio Version
description: What happened? Please, enclose a screenshot whenever possible (even when you think the description is clear). What did you expect to happen? 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: | placeholder: |
What is the problem? OS: Windows 7/8/10/11 ... , Ubuntu 22.04/Fedora 36 ... , macOS 10.15/11.1/12.3 ...
What did you expect?
Paste or drop screenshots here
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: to_reproduce id: system_info
attributes: attributes:
label: Project file & How to reproduce label: Additional system information
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)." 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: | placeholder: |
`File`->`Save project as...` then zip it & drop it here
Also, if needed include the steps to reproduce the bug:
1. Go to '...' 1. Go to '...'
2. Click on '....' 2. Click on '....'
3. Scroll down to '....' 3. Scroll down to '....'
4. See error 4. See error
validations: validations:
required: true required: true
- type: input - type: textarea
id: version id: actual_results
attributes: attributes:
label: Version label: Actual results
description: Which version of Bambu Studio are you running? You can see the full version in `Help` -> `About Bambu Studio`. description: What happens after the above steps? Please, enclose a screenshot whenever possible (even when you think the description is clear).
placeholder: e.g. Bambu Studio 1.6.2.4
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: system_info id: expected_results
attributes: attributes:
label: System Information label: Expected results
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. description: What should happen after the above steps?
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/...
validations: validations:
required: true required: true
- type: input - type: markdown
id: printer id: file_required
attributes: attributes:
label: Printer model value: |
description: Please, fill this in even when it seems irrelevant. Please be sure to add the following files:
placeholder: Bambu Lab X1 Carbon * 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).
validations: You can export the project file from the application menu in `File`->`Save project as...`, then zip it
required: true * A **log file** for crashes and similar issues.
You can find your log file here:
Windows: `%APPDATA%\BambuStudio\log` or usually `C:\Users\\<your username>\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 - type: textarea
id: app_from id: file_uploads
attributes: attributes:
label: Where is the application from? label: Project file & Debug log uploads
description: please confirm where is your Bambu Studio from description: Drop the project file and debug log here
placeholder: | placeholder: |
e.g. Bambu Lab Official website, Bambu Lab github releases, OTA upgrading(popup box in Bambu Studio) Project File: `File`->`Save project as...` then zip it & drop it here
e.g. Built from source 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: validations:
required: true required: true
- type: checkboxes
id: file_checklist
attributes:
label: Checklist of files to include
options:
- label: Log file
- label: Project file