Skip to content

Commit abedb6f

Browse files
fooselfoosel
committed
🧑‍💻 Add mandatory issue forms
1 parent 7cd725c commit abedb6f

File tree

3 files changed

+135
-0
lines changed

3 files changed

+135
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml

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

0 commit comments

Comments
 (0)