Skip to content

Commit 3b7c2d4

Browse files
mr-manuelmr-manuel
committed
Updated issue templates
1 parent 73eabf0 commit 3b7c2d4

File tree

2 files changed

+93
-13
lines changed

2 files changed

+93
-13
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 46 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,12 @@ body:
1717
1818
* Please try the `nightly` build first, if you are not already using it. It's very likely that the bug is already fixed. See [here](https://mr-manuel.github.io/venus-os_dbus-serialbattery_docs/general/install#nightly-build) how to install it.
1919
20+
* Did you reboot at least once after you saw the issue? If not, reboot and check if the issue still exists.
21+
2022
* Please read the complete [changelog](https://github.com/mr-manuel/dbus-serialbattery/blob/master/CHANGELOG.md).
2123
24+
* Make sure to provide the logfiles in the correct format with a READABLE timestamp.
25+
2226
- type: textarea
2327
id: description
2428
attributes:
@@ -51,6 +55,20 @@ body:
5155
validations:
5256
required: true
5357

58+
- dropdown:
59+
id: install_method
60+
attributes:
61+
label: Installation method
62+
description: Select how you installed the driver.
63+
multiple: false
64+
options:
65+
- ⚠️ Choose your option ⚠️
66+
- Install script from the documentation
67+
- Install script present in the driver folder
68+
- SFTP upload
69+
- USB stick
70+
- Other (please describe in the last textfield how you installed the driver)
71+
5472
- type: input
5573
id: driver_version_installed
5674
attributes:
@@ -81,15 +99,18 @@ body:
8199
multiple: false
82100
# https://github.com/victronenergy/venus/wiki/machines
83101
options:
84-
- Please select
102+
- ⚠️ Choose your option ⚠️
85103
- CCGX
86104
- Cerbo GX
87105
- Ekrano GX
88-
- GX Card (integrated in Victron device)
106+
- GX Card (integrated in the Victron device)
89107
- Octo GX
90108
- Raspberry Pi 2
91109
- Raspberry Pi 3
92110
- Raspberry Pi 4
111+
- Raspberry Pi 5
112+
- Raspberry Pi Zero 2W
113+
- Raspberry Pi Zero
93114
- VANcu GX
94115
- Venus_GX
95116
validations:
@@ -103,7 +124,7 @@ body:
103124
Visible in the remote console/GUI under `Settings` -> `Firmware` -> `Firmware version`
104125
105126
⚠️ **IMPORTANT:** Do not write `latest` and specify the exact version number, else we cannot help you.
106-
placeholder: e.g. v2.94
127+
placeholder: e.g. v3.60
107128
validations:
108129
required: true
109130

@@ -127,6 +148,7 @@ body:
127148
- Jiabaida JDB BMS (LLT Power, Overkill Solar, Smart BMS)
128149
- JKBMS (Heltec BMS)
129150
- JKBMS Inverter (JKBMS PB Model)
151+
- Kilovault
130152
- LiTime
131153
- MNB spi BMS
132154
- Pace BMS
@@ -160,7 +182,7 @@ body:
160182
description: Select how you connected your battery to the Venus OS device.
161183
multiple: false
162184
options:
163-
- Please select
185+
- ⚠️ Choose your option ⚠️
164186
- Serial USB adapter to TTL
165187
- Serial USB adapter to RS485
166188
- Raspberry Pi RS485 HAT
@@ -169,12 +191,29 @@ body:
169191
validations:
170192
required: true
171193

194+
- type: dropdown
195+
id: usb_hub
196+
attributes:
197+
label: USB hub
198+
description: |
199+
Select if you use a USB hub to connect the Serial USB adapter to the Venus OS device.
200+
201+
⚠️ **IMPORTANT:** If you use a USB hub, try to connect the Serial USB adapter directly to the Venus OS device to see if the issue still exists.
202+
multiple: false
203+
options:
204+
- ⚠️ Choose your option ⚠️
205+
- No
206+
- Yes, no external power supply
207+
- Yes, with external power supply
208+
validations:
209+
required: true
210+
172211
- type: textarea
173212
id: config
174213
attributes:
175214
label: Config file
176215
description: |
177-
Paste your `config.ini` file here. See [here](https://mr-manuel.github.io/venus-os_dbus-serialbattery_docs/general/install#settings-locationpath) where you can find it. DO NOT COPY the `config.default.ini` here. The content will be automatically formatted into code, so no need for backticks.
216+
Paste your `config.ini` file here. See [here](https://mr-manuel.github.io/venus-os_dbus-serialbattery_docs/general/install#settings-locationpath) where you can find it. DO NOT COPY the `config.default.ini` here. The content will be automatically formatted into code, so no need for tripple backticks.
178217
render: ini
179218
validations:
180219
required: true
@@ -184,7 +223,7 @@ body:
184223
attributes:
185224
label: Relevant log output
186225
description: |
187-
Please copy and paste any relevant log output here. See [here](https://mr-manuel.github.io/venus-os_dbus-serialbattery_docs/troubleshoot/#driver-log-files) how to get the driver log files. The content will be automatically formatted into code, so no need for backticks.
226+
Please copy and paste any relevant log output here. See [here](https://mr-manuel.github.io/venus-os_dbus-serialbattery_docs/troubleshoot/#driver-log-files) how to get the driver log files. The content will be automatically formatted into code, so no need for tripple backticks.
188227
189228
⚠️ **IMPORTANT:** Do not forget to pipe the output through `tai64nlocal`, if you don't copy the commands from the documentation.
190229
render: shell
@@ -195,4 +234,4 @@ body:
195234
id: other
196235
attributes:
197236
label: Any other information that may be helpful
198-
description: Leave empty, if you already said all
237+
description: If you are using a USB hub, paste a link to it here. Leave empty, if you already said all.

‎.github/ISSUE_TEMPLATE/support_request.yml‎

Lines changed: 47 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,12 @@ body:
1717
1818
* Please try the `nightly` build first, if you are not already using it. It's very likely that the bug is already fixed. See [here](https://mr-manuel.github.io/venus-os_dbus-serialbattery_docs/general/install#nightly-build) how to install it.
1919
20+
* Did you reboot at least once after you saw the issue? If not, reboot and check if the issue still exists.
21+
2022
* Please read the complete [changelog](https://github.com/mr-manuel/dbus-serialbattery/blob/master/CHANGELOG.md).
2123
24+
* Make sure to provide the logfiles in the correct format with a READABLE timestamp.
25+
2226
- type: textarea
2327
id: description
2428
attributes:
@@ -29,6 +33,20 @@ body:
2933
validations:
3034
required: true
3135

36+
- dropdown:
37+
id: install_method
38+
attributes:
39+
label: Installation method
40+
description: Select how you installed the driver.
41+
multiple: false
42+
options:
43+
- ⚠️ Choose your option ⚠️
44+
- Install script from the documentation
45+
- Install script present in the driver folder
46+
- SFTP upload
47+
- USB stick
48+
- Other (please describe in the last textfield how you installed the driver)
49+
3250
- type: input
3351
id: driver_version_installed
3452
attributes:
@@ -59,13 +77,18 @@ body:
5977
multiple: false
6078
# https://github.com/victronenergy/venus/wiki/machines
6179
options:
62-
- Please select
80+
- ⚠️ Choose your option ⚠️
6381
- CCGX
6482
- Cerbo GX
6583
- Ekrano GX
66-
- GX Card (integrated in Victron device)
84+
- GX Card (integrated in the Victron device)
6785
- Octo GX
68-
- Raspberry Pi
86+
- Raspberry Pi 2
87+
- Raspberry Pi 3
88+
- Raspberry Pi 4
89+
- Raspberry Pi 5
90+
- Raspberry Pi Zero 2W
91+
- Raspberry Pi Zero
6992
- VANcu GX
7093
- Venus_GX
7194
validations:
@@ -79,7 +102,7 @@ body:
79102
Visible in the remote console/GUI under `Settings` -> `Firmware` -> `Firmware version`
80103
81104
⚠️ **IMPORTANT:** Do not write `latest` and specify the exact version number, else we cannot help you.
82-
placeholder: e.g. v2.94
105+
placeholder: e.g. v3.60
83106
validations:
84107
required: true
85108

@@ -103,6 +126,7 @@ body:
103126
- Jiabaida JDB BMS (LLT Power, Overkill Solar, Smart BMS)
104127
- JKBMS (Heltec BMS)
105128
- JKBMS Inverter (JKBMS PB Model)
129+
- Kilovault
106130
- LiTime
107131
- MNB spi BMS
108132
- Pace BMS
@@ -136,7 +160,7 @@ body:
136160
description: Select how you connected your battery to the Venus OS device.
137161
multiple: false
138162
options:
139-
- Please select
163+
- ⚠️ Choose your option ⚠️
140164
- Serial USB adapter to TTL
141165
- Serial USB adapter to RS485
142166
- Raspberry Pi RS485 HAT
@@ -145,6 +169,23 @@ body:
145169
validations:
146170
required: true
147171

172+
- type: dropdown
173+
id: usb_hub
174+
attributes:
175+
label: USB hub
176+
description: |
177+
Select if you use a USB hub to connect the Serial USB adapter to the Venus OS device.
178+
179+
⚠️ **IMPORTANT:** If you use a USB hub, try to connect the Serial USB adapter directly to the Venus OS device to see if the issue still exists.
180+
multiple: false
181+
options:
182+
- ⚠️ Choose your option ⚠️
183+
- No
184+
- Yes, no external power supply
185+
- Yes, with external power supply
186+
validations:
187+
required: true
188+
148189
- type: textarea
149190
id: config
150191
attributes:
@@ -170,4 +211,4 @@ body:
170211
id: other
171212
attributes:
172213
label: Any other information that may be helpful
173-
description: Leave empty, if you already said all
214+
description: If you are using a USB hub, paste a link to it here. Leave empty, if you already said all.

0 commit comments

Comments
 (0)