Skip to content

Commit 216c7d1

Browse files
authored
Merge pull request #154 from plugwise/issue_templates
Issue templates coherency with -beta
2 parents ced3e45 + cd4a38a commit 216c7d1

File tree

6 files changed

+288
-76
lines changed

6 files changed

+288
-76
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
name: Bug or problem.
2+
description: Report an issue with the Plugwise module.
3+
title: "[BUG]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
This issue form is for reporting bugs only!
10+
11+
If you have a feature or enhancement request, please use the appropriate [issue template][it].
12+
13+
[it]: https://github.com/plugwise/python-plugwise/issues/new/choose
14+
- type: textarea
15+
validations:
16+
required: true
17+
attributes:
18+
label: Describe the bug.
19+
description: >-
20+
Tell us what you were trying to do and what happened. Provide a clear and concise description of what the problem is.
21+
- type: textarea
22+
validations:
23+
required: true
24+
attributes:
25+
label: Expected behavior
26+
description: >-
27+
A clear and concise description of what you expected to happen. If applicable, add screenshots to help explain your problem.
28+
- type: markdown
29+
attributes:
30+
value: |
31+
## Environment
32+
- type: input
33+
id: version
34+
validations:
35+
required: true
36+
attributes:
37+
label: What version of Home Assistant Core has the issue?
38+
placeholder: core-
39+
description: >
40+
Can be found in: [Configuration panel -> Info](https://my.home-assistant.io/redirect/info/). **If not using Home Assistant, provide information on what you integrated with.**
41+
42+
[![Open your Home Assistant instance and show your Home Assistant version information.](https://my.home-assistant.io/badges/info.svg)](https://my.home-assistant.io/redirect/info/)
43+
- type: dropdown
44+
validations:
45+
required: true
46+
attributes:
47+
label: What type of installation are you running?
48+
description: >
49+
Can be found in: [Configuration panel -> Info](https://my.home-assistant.io/redirect/info/).
50+
51+
When selecting `Core`: remember to specify your way of running in the `additional information` textarea at the bottom, including your python version!
52+
53+
[![Open your Home Assistant instance and show your Home Assistant version information.](https://my.home-assistant.io/badges/info.svg)](https://my.home-assistant.io/redirect/info/)
54+
options:
55+
- Home Assistant OS
56+
- Home Assistant Container
57+
- Home Assistant Supervised
58+
- Home Assistant Core
59+
- Other tool (described above)
60+
- type: dropdown
61+
validations:
62+
required: true
63+
attributes:
64+
label: How and which version of the integration do you have installed?
65+
description: >
66+
If you are using just Home Assistant and did not add anything special, choose `Home Assistant Core`.
67+
68+
options:
69+
- Home Assistant Core
70+
- HACS
71+
- Manually installed `custom_component`
72+
- Cloned from GitHub
73+
- I'm not using Home Assistant
74+
- type: markdown
75+
attributes:
76+
value: |
77+
# Plugwise Information
78+
- type: dropdown
79+
validations:
80+
required: true
81+
attributes:
82+
label: What kind of Plugwise device is having issues?
83+
description: >
84+
Select the best possible option (i.e. for issues with a Lisa or Tom, select Adam - for issues with a Circle, select Stretch or USB).
85+
options:
86+
- "Smile: Adam (including Lisa, Tom, Floor)"
87+
- "Smile: Anna"
88+
- "Smile: P1"
89+
- "Smile: Stretch"
90+
- "USB: Stick"
91+
- "Other product (we might not (yet) know of it's existence!)"
92+
- type: input
93+
validations:
94+
required: true
95+
attributes:
96+
label: What firmware version is your Plugwise product at?
97+
placeholder: "x.y.z"
98+
description: >
99+
If not using Home Assistant or unsure, please check the Plugwise mobile app.
100+
101+
Check within Home Assistant by following the below link to your integrations page. You can find your firmware version on the device page.
102+
103+
[![Open your Home Assistant instance and show the integration page.](https://my.home-assistant.io/badges/integrations.svg)](https://my.home-assistant.io/redirect/integrations/)
104+
- type: markdown
105+
attributes:
106+
value: |
107+
# Details
108+
- type: textarea
109+
attributes:
110+
label: Home Assistant Logging (optional)
111+
description: >-
112+
Very important to understand the problem, enable logging for `plugwise` in `configuration.yaml` by adding:
113+
114+
```
115+
logger:
116+
default: warn
117+
logs:
118+
custom_components.plugwise: debug
119+
plugwise.smile: debug
120+
```
121+
122+
After adding this, restart HA Core.
123+
124+
After the restart has finished please look in the supervisor **Core** logs (follow the below link and select 'Core' from the dropdown).
125+
126+
[![Open your Home Assistant instance and show the supervisor logs.](https://my.home-assistant.io/badges/supervisor_logs.svg)](https://my.home-assistant.io/redirect/supervisor_logs/)
127+
128+
There should be several lines related to `plugwise-beta`. Please show us the **complete** log-message that starts this:
129+
130+
```[custom_components.plugwise] Data: PlugwiseData(gateway={'smile_name': ...```
131+
132+
- type: textarea
133+
attributes:
134+
label: Generic or other logging (provide tools and version used)
135+
label: Diagnostics information
136+
description: >-
137+
Provide your version of python used and/or include any and all informational, error and debug messages.
138+
- type: textarea
139+
attributes:
140+
label: Additional information
141+
description: >
142+
If you have any additional information for us, use the field below.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 45 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Home Assistant Core integration
4+
url: https://www.home-assistant.io/integrations/plugwise/
5+
about: For more details on the Core integration this module works best with.
6+
- name: Custom component (beta-testing) for Home Assistant
7+
url: https://github.com/plugwise/plugwise-beta/
8+
about: For more information on the component.
9+
- name: Plugwise Support
10+
url: https://www.plugwise.com/support/
11+
about: For product support from Plugwise.
12+
- name: Home Assistant Community forum
13+
url: https://community.home-assistant.io/t/plugwise-core-and-custom-component/236250
14+
about: Please ask and answer questions here.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 31 deletions
This file was deleted.
Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
name: Feature request
2+
description: Suggest an idea for this project.
3+
title: "[FEATURE]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
This issue form is for requesting features. Please note that we are
10+
not affiliated to Plugwise nor Nabu Casa and just humble developers
11+
supporting Plugwise hardware to work via this module with Home Assistant.
12+
13+
While the module is not exclusive to Home Assistant, it's written with
14+
Home Assistant in mind, nevertheless it was written in e generic way and
15+
provides proper functionality to any python based integration.
16+
17+
If you have a problem, please use the appropriate [issue template][it].
18+
19+
[it]: https://github.com/plugwise/python-plugwise/issues/new/choose
20+
- type: textarea
21+
validations:
22+
required: true
23+
attributes:
24+
label: Describe the solution you are looking for
25+
description: >-
26+
A clear and concise description of any alternative solutions or features you've considered.
27+
- type: textarea
28+
validations:
29+
required: false
30+
attributes:
31+
label: Is your feature request related to a problem? (optional)
32+
description: >-
33+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
34+
- type: textarea
35+
validations:
36+
required: true
37+
attributes:
38+
label: Describe alternatives you've considered
39+
description: >-
40+
A clear and concise description of any alternative solutions or features you've considered.
41+
- type: markdown
42+
attributes:
43+
value: |
44+
# Your setup
45+
- type: dropdown
46+
validations:
47+
required: true
48+
attributes:
49+
label: What type of installation are you running?
50+
description: >
51+
Can be found in: [Configuration panel -> Info](https://my.home-assistant.io/redirect/info/). **If not using Home Assistant, provide information on what you integrated with.**
52+
53+
When selecting `Core`: remember to specify your way of running in the `additional information` textarea at the bottom, including your python version!
54+
55+
[![Open your Home Assistant instance and show your Home Assistant version information.](https://my.home-assistant.io/badges/info.svg)](https://my.home-assistant.io/redirect/info/)
56+
options:
57+
- Home Assistant OS
58+
- Home Assistant Container
59+
- Home Assistant Supervised
60+
- Home Assistant Core
61+
- Other tool(ing) (i.e. not Home Assistant)
62+
- type: dropdown
63+
validations:
64+
required: true
65+
attributes:
66+
label: How did you install python-plugwise (or `plugwise`) for short
67+
description: >
68+
If you are a Home Assistant user and are not aware of anything special, choose `Home Assistant Core`.
69+
options:
70+
- Other use (installed using `pip`)
71+
- Other use (cloned from Github)
72+
- Home Assistant Core
73+
- HA using HACS
74+
- HA using Manually installed `custom_component`
75+
- Cloned from GitHub
76+
- type: markdown
77+
attributes:
78+
value: |
79+
# Plugwise Information
80+
- type: dropdown
81+
validations:
82+
required: true
83+
attributes:
84+
label: What kind of Plugwise device is having issues?
85+
description: >
86+
Select the best possible option (i.e. for issues with a Lisa or Tom, select Adam - for issues with a Circle, select Stretch or USB).
87+
options:
88+
- "Smile: Adam (including Lisa, Tom, Floor)"
89+
- "Smile: Anna"
90+
- "Smile: P1"
91+
- "Smile: Stretch"
92+
- "USB: Stick"
93+
- "Other product (we might not (yet) know of it's existence!)"
94+
- type: input
95+
validations:
96+
required: true
97+
attributes:
98+
label: What firmware version is your Plugwise product at?
99+
placeholder: core-
100+
description: >
101+
If not using Home Assistant or unsure, please check the Plugwise mobile app.
102+
103+
Check within Home Assistant by following the below link to your integrations page. You can find your firmware version on the device page. Otherwise check the Plugwise mobile app.
104+
105+
[![Open your Home Assistant instance and show the integration page.](https://my.home-assistant.io/badges/integrations.svg)](https://my.home-assistant.io/redirect/integrations/)
106+
- type: textarea
107+
validations:
108+
required: true
109+
attributes:
110+
label: Your setup
111+
description: >
112+
What additional components do you have such as Anna, Lisa, Koen, Floor, Tom, etc. - what kind of auxiliary devices as boilers/heaters/heat-exchangers
113+
- type: markdown
114+
attributes:
115+
value: |
116+
# Additional information
117+
- type: textarea
118+
attributes:
119+
label: Additional context
120+
description: >
121+
Add any other context or screenshots about the feature request here.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name: Todo Item
2+
description: Create a todo to help keep track.
3+
title: "[TODO]: "
4+
body:
5+
- type: textarea
6+
validations:
7+
required: true
8+
attributes:
9+
label: Todo
10+
description: >-
11+
A clear and concise description of what to do.

0 commit comments

Comments
 (0)