diff options
author | Ghostkeeper <rubend@tutanota.com> | 2019-12-09 14:56:30 +0300 |
---|---|---|
committer | Ghostkeeper <rubend@tutanota.com> | 2019-12-09 14:56:30 +0300 |
commit | 6aa8d060d5ecfb764d5b7ffe15f9415090647ad0 (patch) | |
tree | f27b5d775bc576612f7d460007562b49ce42d78b /.github/ISSUE_TEMPLATE.md | |
parent | 2dc4681d913f816c4232673c6dcd7891ba17525f (diff) |
Make template a bit less intimidating and restore brackets again
I think the 'why' of things is not always relevant and makes people prevent reading all of it. Keep it brief! And with all of this information that people tend to just leave there it's hard to find the actual changes that people made to the template. That's also why the brackets are important, so that it's easy to see that people didn't erase the original template text.
We used to have HTML comment codes there but then people put the actual bug report inside the comments as well and nothing showed up, so this is somewhat of a middle ground that everyone understands, programmers and non-programmers.
Diffstat (limited to '.github/ISSUE_TEMPLATE.md')
-rw-r--r-- | .github/ISSUE_TEMPLATE.md | 22 |
1 files changed, 8 insertions, 14 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 02fc0f1a65..6934354a70 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -21,19 +21,17 @@ 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 and maybe GPU.) **Printer** -(Which printer was selected in Cura? +(Which printer was selected in Cura?) **Reproduction steps** -1. Something you did. -2. Something you did next. +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. +(Image showing the problem, perhaps before/after images.) **Actual results** (What happens after the above steps have been followed.) @@ -42,14 +40,10 @@ Feel free to add text either inside or below the screenshots. Before (earlier, w (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" +(For slicing bugs, provide a project which clearly shows the bug, by going to File->Save. For big files you may need to use WeTransfer or similar file sharing sites.) **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 +(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) +(Extra information relevant to the issue.) |