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 #804

Merged
merged 1 commit into from
Sep 17, 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
8 changes: 6 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,8 @@ body:
id: config
attributes:
label: Config file
description: Paste your config file here. See [here](https://louisvdw.github.io/dbus-serialbattery/general/install#settings-locationpath) where you can find it. to get This will be automatically formatted into code, so no need for backticks.
description: |
Paste your config file here. See [here](https://louisvdw.github.io/dbus-serialbattery/general/install#settings-locationpath) where you can find it. The content will be automatically formatted into code, so no need for backticks.
render: ini
validations:
required: true
Expand All @@ -137,7 +138,9 @@ body:
id: logs
attributes:
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. This will be automatically formatted into code, so no need for backticks.
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:
required: true
Expand All @@ -146,3 +149,4 @@ body:
id: other
attributes:
label: Any other information that may be helpful
description: Leave empty, if you already said all
9 changes: 7 additions & 2 deletions .github/ISSUE_TEMPLATE/support_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ body:
- Please select
- Serial USB adapter to TTL
- Serial USB adapter to RS485
- Raspberry Pi RS485 HAT
- Bluetooth
validations:
required: true
Expand All @@ -105,7 +106,8 @@ body:
id: config
attributes:
label: Config file
description: Paste your config file here. See [here](https://louisvdw.github.io/dbus-serialbattery/general/install#settings-locationpath) where you can find it. to get This will be automatically formatted into code, so no need for backticks.
description: |
Paste your config file here. See [here](https://louisvdw.github.io/dbus-serialbattery/general/install#settings-locationpath) where you can find it. The content will be automatically formatted into code, so no need for backticks.
render: ini
validations:
required: true
Expand All @@ -114,7 +116,9 @@ body:
id: logs
attributes:
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. This will be automatically formatted into code, so no need for backticks.
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:
required: true
Expand All @@ -123,3 +127,4 @@ body:
id: other
attributes:
label: Any other information that may be helpful
description: Leave empty, if you already said all