Skip to content

Commit 15c8c6b

Browse files
fooselfoosel
committed
🧑‍💻 Add & enforce issue templates
1 parent a3305d6 commit 15c8c6b

3 files changed

Lines changed: 126 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
name: 🐛 Report a bug
2+
description: Create a bug report to help improve File Check
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: >-
7+
**Thank you for wanting to report a bug in File Check!**
8+
9+
* First, be sure you are running the [latest version of the File Check plugin](https://github.com/OctoPrint/OctoPrint-FileCheck/releases).
10+
* You will also need to [enable debug logging on the plugin](https://docs.octoprint.org/en/master/configuration/logging_yaml.html).
11+
* This may be done through the *Settings* > *OctoPrint* > *Logging* > *Logging Levels* section.
12+
* Select the `octoprint.plugins.file_check` name, and make sure Level is "DEBUG".
13+
* Save, then restart OctoPrint, which allows the developers to see debug information from the moment the plugin is loaded.
14+
* 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.
15+
16+
Thank you for your help!
17+
- type: textarea
18+
attributes:
19+
label: The problem
20+
description: >-
21+
Describe the issue you are experiencing here. Tell us what you were trying to do
22+
step by step, and what happened that you did not expect.
23+
24+
Provide a clear and concise description of what the problem is and include as many
25+
details as possible.
26+
placeholder: |
27+
1. ...
28+
2. ...
29+
3. ...
30+
validations:
31+
required: true
32+
- type: markdown
33+
attributes:
34+
value: |
35+
## Environment
36+
- type: input
37+
attributes:
38+
label: Version of File Check
39+
description: Can be found in *Settings* > *Plugin Manager*, next to "File Check".
40+
validations:
41+
required: true
42+
- type: input
43+
attributes:
44+
label: Version of OctoPrint
45+
description: Can be found in the lower left corner of the web interface.
46+
validations:
47+
required: true
48+
- type: input
49+
attributes:
50+
label: Operating system running OctoPrint
51+
description: >-
52+
OctoPi, Linux, Windows, MacOS, something else? With version please? OctoPi's
53+
version can be found in `/etc/octopi_version` or in the lower left corner of the
54+
web interface.
55+
validations:
56+
required: true
57+
- type: input
58+
attributes:
59+
label: Browser and version of browser, operating system running browser
60+
description: If applicable, always include if unsure
61+
- type: markdown
62+
attributes:
63+
value: |
64+
## Logs and other files needed for analysis
65+
- type: markdown
66+
attributes:
67+
value: >-
68+
Please also be sure to upload the following files below:
69+
70+
* 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. Note that you'll need at least OctoPrint 1.6.0 for this to be available - we no longer accept bug reports created for older versions than this.
71+
* 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**!
72+
* GCODE files with which to reproduce, if you are reporting an issue with
73+
any of the included checks.
74+
* Your browser's JavaScript console, if you are reporting a problem with the
75+
user interface. See [here](https://webmasters.stackexchange.com/questions/8525/how-to-open-the-javascript-console-in-different-browsers) on where to find that.
76+
* If possible, screenshots or videos showing the problem, especially if you
77+
are reporting a problem with the user interface!
78+
79+
Please be aware that unless at least Systeminfo Bundle is included, your bug report
80+
will not be processed and closed after a while.
81+
- type: checkboxes
82+
attributes:
83+
label: Checklist of files to include below
84+
options:
85+
- label: Systeminfo Bundle (always include!)
86+
required: true
87+
- label: GCODE file with which to reproduce (always include in case of issues with any checks)
88+
- label: Contents of the JavaScript browser console (always include in cases of issues with the user interface)
89+
- label: Screenshots and/or videos showing the problem (always include in case of issues with the user interface)
90+
- type: textarea
91+
attributes:
92+
label: Additional information & file uploads

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 🤔 Have questions or need support?
4+
url: https://community.octoprint.org
5+
about: Please get in touch on the OctoPrint Community Forums!
6+
- name: 💸 Want to donate?
7+
url: https://support.octoprint.org
8+
about: Please take a look at the various options to support OctoPrint's development financially!

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: ✨ Request a feature
2+
description: Request a new feature to implement in File Check
3+
title: "[Request]"
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: >
8+
**Thank you for wanting to request a feature in File Check!**
9+
- type: textarea
10+
attributes:
11+
label: Is your feature request related to a problem? Please describe.
12+
description: A clear and concise description of what the problem is. Eg, "I'm always frustrated when [...]".
13+
- type: textarea
14+
attributes:
15+
label: Describe the solution you'd like
16+
description: A clear and concise description of what you want to happen.
17+
validations:
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: Describe alternatives you've considered
22+
description: A clear and concise description of any alternative solutions or features you've considered.
23+
- type: textarea
24+
attributes:
25+
label: Additional context
26+
description: Add any other context or screenshots about the feature request here.

0 commit comments

Comments
 (0)