GitHub-Proxy/Cura
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/Ultimaker/Cura synced 2025-05-22 04:29:01 +08:00
Code Issues Packages Projects Releases Wiki Activity

Break down the issue template header into sections.

Browse Source 
I fear people might simply ignore the header, which is surrounded by
comment tags. Having headings for all important pieces of information
might make them stand out more.
This commit is contained in:
Nino van Hooff 2019-12-06 14:23:42 +01:00
parent f7709c11bc
commit c47aca2f1b
2 changed files with 57 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
.github/ISSUE_TEMPLATE.md vendored
View File

@ -1,12 +1,18 @@
---
name: Bug report
about: Create a report to help us fix issues.
title: ''
labels: 'Type: Bug'
assignees: ''
---
<!--
The following template is useful for filing new issues. Processing an issue will go much faster when this is filled out, and issues which do not use this template WILL BE REMOVED.
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.
It is also helpful to attach a project (.3mf or .curaproject) file and Cura log file so we can debug issues quicker.
Information about how to find the log file can be found at https://github.com/Ultimaker/Cura/wiki/Cura-Preferences-and-Settings-Locations. To upload a project, try changing the extension to e.g. .curaproject.3mf.zip so that github accepts uploading the file. Otherwise we recommend http://wetransfer.com, but other file hosts like Google Drive or Dropbox work well too.
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!
-->
@ -15,20 +21,40 @@ Thank you for using Cura!
(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. In the case of visual glitches/issues, also include information about your graphics drivers and GPU.)
(Information about the operating system the issue occurs on. Include at least the operating system.
In the case of visual glitches/issues, also include information about your graphics drivers and GPU.)
**Printer**
(Which printer was selected in Cura? If possible, please attach project file as .curaproject.3mf.zip.)
(Which printer was selected in Cura?
**Reproduction steps**
1. Something you did.
2. Something you did next.
**Screenshot(s)**
Adding screenshot(s) is a very good idea to identify what exactly the problem is. We get lots of bug reports and a
screenshot is also a great help to tell them apart without downloading and opening a project file. Feel
free to add text either inside or below the screenshots. Before (earlier, working version of Cura) / After
(Problematic version of Cura) screenshots might work well, too.
**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**
Provide a project which clearly shows the bug.
Rather than providing a model file, provide a project (.3mf or .curaproject) file. This will include all the settings
you used, which is crucial to reproducing your problem.
To upload a project, try changing the extension to e.g. bug_example.3mf.zip so that GitHub accepts uploading the file.
If the file is too big, we recommend http://wetransfer.com, but other file hosts like Google Drive or Dropbox work
well too. Please make sure the file is publicly available ie. "shared with everyone"
**Log file**
It is important to provide a log file. It might provide us info about why a certain material was selected, or is not
compatible, for example.
Information about how to find the log file can be found at https://github.com/Ultimaker/Cura#logging-issues
**Additional information**
(Extra information relevant to the issue, like screenshots. Don't forget to attach the log files with this issue report.)
(Extra information relevant to the issue)

30
.github/ISSUE_TEMPLATE/bug-report.md vendored
View File

@ -14,10 +14,6 @@ Before filing, PLEASE check if the issue already exists (either open or closed)
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.
It is also helpful to attach a project (.3mf or .curaproject) file and Cura log file so we can debug issues quicker. Information about how to find the log file can be found at https://github.com/Ultimaker/Cura#logging-issues
To upload a project, try changing the extension to e.g. .curaproject.3mf.zip so that GitHub accepts uploading the file. Otherwise, we recommend http://wetransfer.com, but other file hosts like Google Drive or Dropbox work well too.
Thank you for using Cura!
-->
@ -25,20 +21,40 @@ Thank you for using Cura!
(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. In the case of visual glitches/issues, also include information about your graphics drivers and GPU.)
(Information about the operating system the issue occurs on. Include at least the operating system.
In the case of visual glitches/issues, also include information about your graphics drivers and GPU.)
**Printer**
(Which printer was selected in Cura? If possible, please attach project file as .curaproject.3mf.zip.)
(Which printer was selected in Cura?
**Reproduction steps**
1. Something you did.
2. Something you did next.
**Screenshot(s)**
Adding screenshot(s) is a very good idea to identify what exactly the problem is. We get lots of bug reports and a
screenshot is also a great help to tell them apart without downloading and opening a project file. Feel
free to add text either inside or below the screenshots. Before (earlier, working version of Cura) / After
(Problematic version of Cura) screenshots might work well, too.
**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**
Provide a project which clearly shows the bug.
Rather than providing a model file, provide a project (.3mf or .curaproject) file. This will include all the settings
you used, which is crucial to reproducing your problem.
To upload a project, try changing the extension to e.g. bug_example.3mf.zip so that GitHub accepts uploading the file.
If the file is too big, we recommend http://wetransfer.com, but other file hosts like Google Drive or Dropbox work
well too. Please make sure the file is publicly available ie. "shared with everyone"
**Log file**
It is important to provide a log file. It might provide us info about why a certain material was selected, or is not
compatible, for example.
Information about how to find the log file can be found at https://github.com/Ultimaker/Cura#logging-issues
**Additional information**
(Extra information relevant to the issue, like screenshots. Don't forget to attach the log files with this issue report.)
(Extra information relevant to the issue)