Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated issue templates #826

Merged
merged 4 commits into from
Sep 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ body:
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is. Paste also screenshots, if needed.
placeholder: |
NOTE: Paste the logfields in the appropriate field below.
validations:
required: true

Expand All @@ -24,7 +26,7 @@ body:
attributes:
label: How to reproduce
description: Please describe in clear steps how to reproduce the issue. Paste also screenshots, if needed.
value: |
placeholder: |
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
Expand All @@ -45,7 +47,11 @@ body:
id: driver_version
attributes:
label: Driver version
description: Visible in the [driver log files](https://louisvdw.github.io/dbus-serialbattery/troubleshoot/#driver-log-files) or in the remote console/GUI under `SerialBattery` -> `Device` -> `Firmware version`
description: |
Visible in the [driver log files](https://louisvdw.github.io/dbus-serialbattery/troubleshoot/#driver-log-files) or in the remote console/GUI under `SerialBattery` -> `Device` -> `Firmware version`.

⚠️ **IMPORTANT:** Do not write `latest` and specify the exact version number, else we cannot help you.
placeholder: e.g. v1.0.20230927beta
validations:
required: true

Expand Down Expand Up @@ -73,7 +79,10 @@ body:
id: venus_os_version
attributes:
label: Venus OS version
description: Visible in the remote console/GUI under `Settings` -> `Firmware` -> `Firmware version`
description: |
Visible in the remote console/GUI under `Settings` -> `Firmware` -> `Firmware version`

⚠️ **IMPORTANT:** Do not write `latest` and specify the exact version number, else we cannot help you.
placeholder: e.g. v2.94
validations:
required: true
Expand Down Expand Up @@ -140,6 +149,7 @@ body:
label: Relevant log output
description: |
Please copy and paste any relevant log output here. See [here](https://louisvdw.github.io/dbus-serialbattery/troubleshoot/#driver-log-files) how to get the driver log files. The content will be automatically formatted into code, so no need for backticks.

⚠️ **IMPORTANT:** Do not forget to pipe the output through `tai64nlocal`, if you don't copy the commands from the documentation.
render: shell
validations:
Expand Down
13 changes: 11 additions & 2 deletions .github/ISSUE_TEMPLATE/support_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,20 @@ body:
attributes:
label: Describe the problem
description: A clear and concise description of what the problem is. Paste also screenshots and pictures, if needed. The more informations you give, the faster we find a solution.
placeholder: |
NOTE: Paste the logfields in the appropriate field below.
validations:
required: true

- type: input
id: driver_version
attributes:
label: Driver version
description: Visible in the [driver log files](https://louisvdw.github.io/dbus-serialbattery/troubleshoot/#driver-log-files) or in the remote console/GUI under `SerialBattery` -> `Device` -> `Firmware version`
description: |
Visible in the [driver log files](https://louisvdw.github.io/dbus-serialbattery/troubleshoot/#driver-log-files) or in the remote console/GUI under `SerialBattery` -> `Device` -> `Firmware version`.

⚠️ **IMPORTANT:** Do not write `latest` and specify the exact version number, else we cannot help you.
placeholder: e.g. v1.0.20230927beta
validations:
required: true

Expand Down Expand Up @@ -51,7 +57,10 @@ body:
id: venus_os_version
attributes:
label: Venus OS version
description: Visible in the remote console/GUI under `Settings` -> `Firmware` -> `Firmware version`
description: |
Visible in the remote console/GUI under `Settings` -> `Firmware` -> `Firmware version`

⚠️ **IMPORTANT:** Do not write `latest` and specify the exact version number, else we cannot help you.
placeholder: e.g. v2.94
validations:
required: true
Expand Down