-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
π§βπ» Add mandatory issue forms
- Loading branch information
Showing
3 changed files
with
135 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
name: π Report a bug | ||
description: Create a bug report to help improve Firmware Check | ||
labels: | ||
- bug | ||
- triage | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: >- | ||
**Thank you for wanting to report a bug in Firmware Check!** | ||
* First, be sure you are running the [latest version of the Firmware Check plugin](https://github.com/OctoPrint/OctoPrint-FirmwareCheck/releases). | ||
* You will also need to [enable debug logging on the plugin](https://docs.octoprint.org/en/master/configuration/logging_yaml.html). | ||
* This may be done through the *Settings* > *OctoPrint* > *Logging* > *Logging Levels* section. | ||
* Select the `octoprint.plugins.firmware_check` name, and make sure Level is "DEBUG". | ||
* Save, then restart OctoPrint, which allows the developers to see debug information from the moment the plugin is loaded. | ||
* Finally, when submitting a bug report, you **must** [include a Systeminfo Bundle](https://community.octoprint.org/t/what-is-a-systeminfo-bundle-and-how-can-i-obtain-one/29887), generated after the point the bug occurs. This allows the developers to examine the debug logs produced from your plugin installation. | ||
Thank you for your help! | ||
- type: textarea | ||
attributes: | ||
label: The problem | ||
description: >- | ||
Describe the issue you are experiencing here. Tell us what you were trying to do | ||
step by step, and what happened that you did not expect. | ||
Provide a clear and concise description of what the problem is and include as many | ||
details as possible. | ||
placeholder: | | ||
1. ... | ||
2. ... | ||
3. ... | ||
validations: | ||
required: true | ||
- type: markdown | ||
attributes: | ||
value: | | ||
## Environment | ||
- type: input | ||
attributes: | ||
label: Version of Firmware Check | ||
description: Can be found in *Settings* > *Plugin Manager*, next to "Firmware Check". | ||
validations: | ||
required: true | ||
- type: input | ||
attributes: | ||
label: Version of OctoPrint | ||
description: Can be found in the lower left corner of the web interface. | ||
validations: | ||
required: true | ||
- type: input | ||
attributes: | ||
label: Operating system running OctoPrint | ||
description: >- | ||
OctoPi, Linux, Windows, MacOS, something else? With version please? OctoPi's | ||
version can be found in `/etc/octopi_version` or in the lower left corner of the | ||
web interface. | ||
validations: | ||
required: true | ||
- type: input | ||
attributes: | ||
label: Printer model & used firmware incl. version | ||
description: If applicable, always include if unsure | ||
- type: input | ||
attributes: | ||
label: Browser and version of browser, operating system running browser | ||
description: If applicable, always include if unsure | ||
- type: markdown | ||
attributes: | ||
value: | | ||
## Logs and other files needed for analysis | ||
- type: markdown | ||
attributes: | ||
value: >- | ||
Please also be sure to upload the following files below: | ||
* Systeminfo Bundle: See [here](https://community.octoprint.org/t/what-is-a-systeminfo-bundle-and-how-can-i-obtain-one/29887) if you don't know where to find that. Just attach down below as-is. | ||
* If you are reporting an issue that involves communicating with you printer, **be sure to enable `serial.log` before reproducing and creating the Systeminfo Bundle**! | ||
* Your browser's JavaScript console, if you are reporting a problem with the user interface. See [here](https://webmasters.stackexchange.com/questions/8525/how-to-open-the-javascript-console-in-different-browsers) on where to find that. | ||
* If possible, screenshots or videos showing the problem, especially if you are reporting a problem with the user interface! | ||
* GCODE files with which to reproduce. | ||
Please be aware that unless at least Systeminfo Bundle is included, your bug report | ||
will not be processed and closed after a while. | ||
- type: checkboxes | ||
attributes: | ||
label: Checklist of files to include below | ||
options: | ||
- label: Systeminfo Bundle (always include!) | ||
required: true | ||
- label: Contents of the JavaScript browser console (always include in cases of issues with the user interface) | ||
- label: Screenshots and/or videos showing the problem (always include in case of issues with the user interface) | ||
- label: GCODE file with which to reproduce | ||
- type: textarea | ||
attributes: | ||
label: Additional information & file uploads |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: π€ Have questions or need support? | ||
url: https://community.octoprint.org | ||
about: Please get in touch on the OctoPrint Community Forums! | ||
- name: πΈ Want to donate? | ||
url: https://support.octoprint.org | ||
about: Please take a look at the various options to support OctoPrint's development financially! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
name: β¨ Request a feature | ||
description: Request a new feature to implement in Firmware Check | ||
title: "[Request]" | ||
labels: | ||
- request | ||
- triage | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: > | ||
**Thank you for wanting to request a feature in Firmware Check!** | ||
- type: textarea | ||
attributes: | ||
label: Is your feature request related to a problem? Please describe. | ||
description: A clear and concise description of what the problem is. Eg, "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. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Describe alternatives you've considered | ||
description: A clear and concise description of any alternative solutions or features you've considered. | ||
- type: textarea | ||
attributes: | ||
label: Additional context | ||
description: Add any other context, file uploads and/or screenshots about the feature request here. |