Skip to content

Commit 2c61215

Browse files
sfstarsfstar
authored
Merge pull request #294 from sfstar/feature/introduce_issue_template
Add bug, feature and change request issue templates since present template isn't working
2 parents ef427cf + 3e19f64 commit 2c61215

File tree

5 files changed

+108
-45
lines changed

5 files changed

+108
-45
lines changed

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 0 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +0,0 @@
1-
<!-- READ THIS FIRST:
2-
- Provide as many details as possible. Paste logs, configuration samples and code into the backticks.
3-
DO NOT DELETE ANY TEXT from this template! Otherwise, your issue may be closed without comment.
4-
-->
5-
## The problem
6-
<!--
7-
Describe the issue you are experiencing here to communicate to the
8-
maintainers. Tell us what you were trying to do and what happened.
9-
-->
10-
11-
12-
## Environment
13-
<!--
14-
Provide details about the versions you are using, which helps us to reproduce
15-
and find the issue quicker. Version information is of homeassistant found in the
16-
Home Assistant frontend: Settings -> About. The installed version of the integration can be found via HACS -> Victron GX modbus TCP
17-
-->
18-
19-
- Home Assistant Core release with the issue:
20-
- Last working Home Assistant Core release (if known):
21-
- Integration version causing this issue:
22-
23-
## Problem-relevant `configuration dialog`
24-
<!--
25-
An example configuration that caused the problem for you. Fill this out even
26-
if it seems unimportant to you. Please be sure to remove personal information
27-
like passwords, private URLs and other credentials. You can provide it as text or as an screenshot.
28-
-->
29-
30-
```yaml
31-
32-
```
33-
34-
35-
## Traceback/Error logs
36-
<!--
37-
If you come across any trace or error logs, please provide them.
38-
-->
39-
40-
```txt
41-
42-
```
43-
44-
## Additional information
45-

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<!-- READ THIS FIRST:
2+
- Provide as many details as possible. Paste logs, configuration samples and code into the backticks.
3+
DO NOT DELETE ANY TEXT from this template! Otherwise, your issue may be closed without comment.
4+
-->
5+
## The problem
6+
<!--
7+
Describe the issue you are experiencing here to communicate to the
8+
maintainers. Tell us what you were trying to do and what happened.
9+
-->
10+
11+
12+
## Environment
13+
<!--
14+
Provide details about the versions you are using, which helps us to reproduce
15+
and find the issue quicker. Version information is of homeassistant found in the
16+
Home Assistant frontend: Settings -> About. The installed version of the integration can be found via HACS -> Victron GX modbus TCP
17+
-->
18+
19+
- Home Assistant Core release with the issue:
20+
- Last working Home Assistant Core release (if known):
21+
- Integration version causing this issue:
22+
23+
## Problem-relevant `configuration dialog`
24+
<!--
25+
An example configuration that caused the problem for you. Fill this out even
26+
if it seems unimportant to you. Please be sure to remove personal information
27+
like passwords, private URLs and other credentials. You can provide it as text or as an screenshot.
28+
-->
29+
30+
```yaml
31+
32+
```
33+
34+
## Traceback/Error logs
35+
<!--
36+
Enable debug logging and perform steps to trigger the bug to occur. Download the debug logging and provide it and any other relevant HA core erors logs as an attachment to this issue
37+
-->
38+
39+
```txt
40+
41+
```
42+
43+
## In case of unit ID issue, missing devices or non-updating devices
44+
<!--
45+
Go to Settings -> Services -> Modbus TCP on your GX device and provide an screenshot of the devices listed under "Available services"
46+
-->
47+
48+
## Additional information
49+
50+
<!--
51+
Any other relevant information for the bug you are experiencing
52+
-->

‎.github/ISSUE_TEMPLATE/change_request.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Change Request
3+
about: Request an update or change for the integration.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
<!-- IF YOU DO NOT FILL OUT THIS TEMPLATE YOUR ISSUE WILL BE CLOSED -->
9+
<!-- If you delete the template the issue will be closed and you will be asked to resubmit using the template. -->
10+
11+
<!-- DO NOT OPEN AN ISSUE TO ASK HOW TO SET UP OR CONFIGURE THE INTEGRATION -->
12+
<!-- READ THE INSTRUCTIONS: -->
13+
<!-- https://github.com/sfstar/hass-victron/?tab=readme-ov-file#installing-the-integration -->
14+
15+
<!-- Make sure your configuration is correct, switch over your gx device to an wired LAN connection if possible -->
16+
17+
**Describe the current behavior**
18+
A clear and concise description of what the feature should be.
19+
20+
**What should be updated or changed?**
21+
A clear and concise description of the proposed new or updated behavior.
22+
23+
**Home Assistant (please complete the following information):**
24+
- Home Assistant Core Version:
25+
- solaredge-modbus-multi Version:
26+
27+
**Additional context**
28+
Add any other context about the request here.

‎.github/ISSUE_TEMPLATE/config.yml‎

Whitespace-only changes.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Feature Request
3+
about: Request a new feature for the integration.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
<!-- IF YOU DO NOT FILL OUT THIS TEMPLATE YOUR ISSUE WILL BE CLOSED -->
9+
<!-- If you delete the template the issue will be closed and you will be asked to resubmit using the template. -->
10+
11+
<!-- DO NOT OPEN AN ISSUE TO ASK HOW TO SET UP OR CONFIGURE THE INTEGRATION -->
12+
<!-- READ THE INSTRUCTIONS: -->
13+
<!-- https://github.com/sfstar/hass-victron/?tab=readme-ov-file#installing-the-integration -->
14+
15+
<!-- Make sure your configuration is correct, switch over your gx device to an wired LAN connection if possible -->
16+
17+
**Describe the feature**
18+
A clear and concise description of what the feature should be.
19+
20+
**Screenshots**
21+
If applicable, add screenshots or edits of the proposed feature that help describe it.
22+
23+
**Home Assistant (please complete the following information):**
24+
- Home Assistant Core Version:
25+
- solaredge-modbus-multi Version:
26+
27+
**Additional context**
28+
Add any other context about the request here.

0 commit comments

Comments
 (0)