Merge pull request #9365 from Ultimaker/new_issue_templates

New issue templates
2025-08-12 08:58:58 +08:00 · 2021-03-04 16:51:04 +01:00 · 2021-03-04 16:51:04 +01:00 · fdb957ecf2
commit fdb957ecf2
parent f7c45f6cb6 258313d192
4 changed files with 114 additions and 72 deletions
--- a/.github/ISSUE_TEMPLATE/bug-report.md
+++ b/.github/ISSUE_TEMPLATE/bug-report.md
@ -1,49 +0,0 @@
---
-name: Bug report
-about: Create a report to help us fix issues.
-title: ''
-labels: 'Type: Bug'
-assignees: ''
-
---
-
-<!--
-Processing an issue will go much faster when this is filled out, and issues which do not use this template WILL BE REMOVED and no fix will be considered!
-
-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.
-
-Also, please note the application version in the title of the issue. For example: "[3.2.1] Cannot connect to 3rd-party printer". Please do NOT write things like "Request:" or "[BUG]" in the title; this is what labels are for.
-
-Thank you for using Cura!
-->
-
-**Application version**
-(The version of the application this issue occurs with.)
-
-**Platform**
-(Information about the operating system the issue occurs on. Include at least the operating system and maybe GPU.)
-
-**Printer**
-(Which printer was selected in Cura?)
-
-**Reproduction steps**
-1. (Something you did.)
-2. (Something you did next.)
-
-**Screenshot(s)**
-(Image showing the problem, perhaps before/after images.) 
-
-**Actual results**
-(What happens after the above steps have been followed.)
-
-**Expected results**
-(What should happen after the above steps have been followed.)
-
-**Project file**
-(For slicing bugs, provide a project which clearly shows the bug, by going to File->Save Project. For big files you may need to use WeTransfer or similar file sharing sites. G-code files are not project files!)
-
-**Log file**
-(See https://github.com/Ultimaker/Cura#logging-issues to find the log file to upload, or copy a relevant snippet from it.)
-
-**Additional information**
-(Extra information relevant to the issue.)
--- a/.github/ISSUE_TEMPLATE/bugreport.yaml
+++ b/.github/ISSUE_TEMPLATE/bugreport.yaml
@ -0,0 +1,68 @@
+name: BugReport
+description: Create a report to help us fix issues.
+labels: "Type: Bug"
+issue_body: true
+body:
+- type: markdown
+  attributes:
+    value: |
+      **Thank you for using Cura 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. 
+      
+      Also, please note the application version in the title of the issue "For example (3.2.1) Cannot connect to 3rd-party printer". Please do not write things like **Request** or **BUG** in the title, this is what labels are for.
+- type: input
+  attributes:
+    label: Application Version
+    description: The version of Cura this issue occurs with.
+    placeholder: 4.8.0
+  validations:
+    required: true
+- type: input
+  attributes:
+    label: Platform
+    description: Information about the operating system the issue occurs on. Include at least the operating system and maybe GPU.
+    placeholder: Windows 10
+  validations:
+    required: true
+- type: input
+  attributes:
+    label: Printer
+    description: Which printer was selected in Cura?
+    placeholder: Ultimaker S5    
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Reproduction steps
+    description: Tell us what you did!
+    placeholder: |
+      1. Something you did
+      2. Something you did next
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Actual results
+    description: What happens after the above steps have been followed.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Expected results
+    description: What should happen after the above steps have been followed.
+  validations:
+    required: true
+- type: markdown
+  attributes:
+    value: |
+      ## Additional information & file uploads
+      
+      Please be sure to add the following files:
+        * A **project file** that clearly shows the bug. 
+          To save a project file go to `File -> Save project`. Please make sure to .zip your project file. For big files you may need to use WeTransfer or similar file sharing sites. 
+          G-code files are not project files!
+        * **Screenshots** of showing the problem, perhaps before/after images.
+        * A **log file**, see [here](https://github.com/Ultimaker/Cura#logging-issues) how to find the log file. 
+      
+      You can add these files and additional information that is relevant to the issue in the comments below. 
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@ -1,23 +0,0 @@
---
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: 'Type: New Feature'
-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. If possible, describe why you think this is a good solution.)
-
-**Describe alternatives you've considered**
-(A clear and concise description of any alternative solutions or features you've considered. Again, if possible, think about why these alternatives are not working out.)
-
-**Affected users and/or printers**
-(Who do you think will benefit from this? Is everyone going to benefit from these changes? Or specific kinds of users?)
-
-**Additional context**
-(Add any other context or screenshots about the feature request here.)
--- a/.github/ISSUE_TEMPLATE/featurerequest.yaml
+++ b/.github/ISSUE_TEMPLATE/featurerequest.yaml
@ -0,0 +1,46 @@
+name: FeatureRequest
+description: Suggest an idea for this project.
+labels: "Type: New Feature"
+issue_body: true
+body:
+- type: markdown
+  attributes:
+    value: |
+      **Thank you for using Cura and wanting to suggest a new feature.**
+      
+      Before filing, please check if the feature request 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. 
+      
+      Please do not write things like **Request** or **BUG** in the title, this is what labels are for.
+- type: textarea
+  attributes:
+    label: Is your feature request related to a problem?
+    description: Please describe a clear and concise description of what the problem is.
+    placeholder: I'm always frustrated when...
+  validations:
+    required: true 
+- type: textarea
+  attributes:
+    label: Describe the solution you'd like
+    description: A clear and concise description of what you want to happen. If possible, describe why you think this is a good solution. 
+    placeholder: I believe this will solve...
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Describe alternatives you've considerd
+    description: A clear and concise description of any alternative solutions or features you've considered. Again, if possible, think about why these alternatives are not working out.
+    placeholder: The alternatives I've considered are...
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Affected users and/or printers
+    description: Who do you think will benefit from this? Is everyone going to benefit from these changes? Or specific kinds of users?
+    placeholder: It will affect...
+  validations:
+    required: true
+- type: markdown
+  attributes:
+    value: |
+      ## Additional information & file uploads
+      You can add pictures or files to visualize your feature request in the comments below.