From c47aca2f1b2d25d626132a691cc4a1eb93547974 Mon Sep 17 00:00:00 2001 From: Nino van Hooff Date: Fri, 6 Dec 2019 14:23:42 +0100 Subject: Break down the issue template header into sections. 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. --- .github/ISSUE_TEMPLATE.md | 42 +++++++++++++++++++++++++++++------- .github/ISSUE_TEMPLATE/bug-report.md | 30 ++++++++++++++++++++------ 2 files changed, 57 insertions(+), 15 deletions(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 8e56787aeb..10ebdd761c 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,12 +1,18 @@ +--- +name: Bug report +about: Create a report to help us fix issues. +title: '' +labels: 'Type: Bug' +assignees: '' + +--- + @@ -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) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 749b8037c1..10ebdd761c 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -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) -- cgit v1.2.3