From 41d8b3476cdfd59095fa6a7046b8a9af0744782d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gina=20H=C3=A4u=C3=9Fge?= Date: Mon, 27 Mar 2017 15:25:45 +0200 Subject: [PATCH] Added safe mode section to ticket template --- .github/ISSUE_TEMPLATE.md | 57 +++++++++++++++++++++++++-------------- CONTRIBUTING.md | 31 +++++++++++++++++---- 2 files changed, 63 insertions(+), 25 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 229f4b4a..4970021e 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,8 +1,10 @@ READ THE FOLLOWING FIRST: If not already done, please read the "guidelines for contributing" -that are linked ^-- just up there in the big yellow box. Also read -the FAQ: https://github.com/foosel/OctoPrint/wiki/FAQ. +aka the Contribution Guidelines that are linked ^-- just up there +in the big yellow box. + +Also read the FAQ: https://github.com/foosel/OctoPrint/wiki/FAQ. This is a bug and feature tracker, please only use it to report bugs or request features within OctoPrint (not OctoPi, not any OctoPrint @@ -14,18 +16,18 @@ for contributing" linked above, read it!), NOT here. Mark requests with a "[Request]" prefix in the title please. Fully fill out the bug reporting template for bug reports (if you don't know where -to find some information - it's all described in the contribution -guidelines linked up there in the big yellow box). +to find some information - it's all described in the Contribution +Guidelines linked up there in the big yellow box). -When reporting a bug do NOT delete any lines from the template but +When reporting a bug do NOT delete ANY lines from the template but those enclosed in [ and ] - and those please DO delete, they are only provided for your information and removing them makes your ticket more readable :) -Make sure any bug you want to repor tis still present with the CURRENT +Make sure any bug you want to report is still present with the CURRENT OctoPrint version and that it does not vanish when you start OctoPrint -in safe mode - how to do that is also explained in the contribution -guidelines linked up there in the big yellow box. +in safe mode - how to do that is also explained in the Contribution +Guidelines linked up there in the big yellow box. Thank you! @@ -37,15 +39,27 @@ by heart ;)) #### What were you doing? -[Please describe the steps to reproduce your issue. Be as specific as -possible here. The maintainers will need to reproduce your issue in -order to fix it and that is not possible if they don't know what you -did to get it to happen in the first place. +[Please be as specific as possible here. The maintainers will need to +reproduce your issue in order to fix it and that is not possible if they +don't know what you did to get it to happen in the first place. + +Ideally provide exact steps to follow in order to reproduce your problem: + +1. ... +2. ... +3. ... If you encountered a problem with specific files of any sorts, make sure to also include a link to a file with which to reproduce the problem.] -#### What did you expect to happen and what happened instead? +#### What did you expect to happen? + +#### What happened instead? + +#### Did the same happen when running OctoPrint in safe mode? + +[Try to reproduce your problem in safe mode. You can find information +on how to enable safe mode in the Contribution Guidelines.] #### Branch & Commit or Version of OctoPrint @@ -53,7 +67,8 @@ to also include a link to a file with which to reproduce the problem.] #### Operating System running OctoPrint -[OctoPi, Linux, Windows, MacOS, something else? With version please.] +[OctoPi, Linux, Windows, MacOS, something else? With version please. +OctoPi's version can be found in /etc/octopi_version] #### Printer model & used firmware incl. version @@ -61,17 +76,17 @@ to also include a link to a file with which to reproduce the problem.] #### Browser and Version of Browser, Operating System running Browser -[If applicable, always include if unsure or reporting UI issues.] +[If applicable, always include if unsure.] #### Link to octoprint.log -[On gist.github.com or pastebin.com. ALWAYS INCLUDE and never truncate.] +[On gist.github.com or pastebin.com. ALWAYS INCLUDE and never truncate. +The Contribution Guidelines tell you where to find that.] #### Link to contents of terminal tab or serial.log [On gist.github.com or pastebin.com. If applicable, always include if unsure or -reporting any kind of communication issues between OctoPrint and your printer. -Never truncate. +reporting communication issues. Never truncate. serial.log is usually not written due to performance reasons and must be enabled explicitly. Provide at the very least the FULL contents of your @@ -81,9 +96,11 @@ a serial.log.] #### Link to contents of Javascript console in the browser [On gist.github.com or pastebin.com or alternatively a screenshot. If applicable - -always include if unsure or reporting UI issues.] +always include if unsure or reporting UI issues. -#### Screenshot(s) or video(s) showing the problem: +The Contribution Guidelines tell you where to find that.] + +#### Screenshot(s)/video(s) showing the problem: [If applicable. Always include if unsure or reporting UI issues.] diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1f802022..4e3a4743 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -142,6 +142,12 @@ only provided here as some additional information for you), **even if only addin reproduce your issue in order to fix it and that is not possible if they don't know what you did to get it to happen in the first place. + Ideally provide exact steps to follow in order to reproduce your problem: + + 1. ... + 2. ... + 3. ... + If you encountered a problem with specific files of any sorts, make sure to also include a link to a file with which to reproduce the problem.] @@ -149,10 +155,20 @@ only provided here as some additional information for you), **even if only addin #### What happened instead? + #### Did the same happen when running OctoPrint in safe mode? + + [Try to reproduce your problem in safe mode. You can find information + on how to enable safe mode in the Contribution Guidelines.] + #### Branch & Commit or Version of OctoPrint [Can be found in the lower left corner of the web interface. ALWAYS INCLUDE.] + #### Operating System running OctoPrint + + [OctoPi, Linux, Windows, MacOS, something else? With version please, + OctoPi's version can be found in /etc/octopi_version] + #### Printer model & used firmware incl. version [If applicable, always include if unsure.] @@ -163,7 +179,8 @@ only provided here as some additional information for you), **even if only addin #### Link to octoprint.log - [On gist.github.com or pastebin.com. ALWAYS INCLUDE and never truncate.] + [On gist.github.com or pastebin.com. ALWAYS INCLUDE and never truncate. + The Contribution Guidelines tell you where to find that.] #### Link to contents of terminal tab or serial.log @@ -178,16 +195,19 @@ only provided here as some additional information for you), **even if only addin #### Link to contents of Javascript console in the browser [On gist.github.com or pastebin.com or alternatively a screenshot. If applicable - - always include if unsure or reporting UI issues.] + always include if unsure or reporting UI issues. - #### Screenshot(s) showing the problem: + The Contribution Guidelines tell you where to find that.] + + #### Screenshot(s)/video(s) showing the problem: [If applicable. Always include if unsure or reporting UI issues.] I have read the FAQ. -Copy-paste this template **completely**. Do not skip any lines or the bot -*will* complain! +Copy-paste this template **completely** (or use the version that gets pre-filled +into the "new issue" form). Do not skip any lines or the bot *will* complain! Provide +all requested information or your ticket will be closed. ### Where can I find which version and branch I'm on? @@ -405,6 +425,7 @@ the local version identifier to allow for an exact determination of the active c * 2017-03-09: Allow PRs against `maintenance` branch for bugs in stable. * 2017-03-10: Reproduce bugs in safe mode to make sure they are really caused by OctoPrint itself and not a misbehaving plugin. + * 2017-03-27: Added safe mode section to ticket template. ## Footnotes * [1] - If you are wondering why, the problem is that anything that you add