Skip to content

Commit

Permalink
Update issue reports to use GitHub template (#475)
Browse files Browse the repository at this point in the history
  • Loading branch information
iMicknl authored Jul 14, 2021
1 parent 669ac3f commit baf3aac
Show file tree
Hide file tree
Showing 9 changed files with 311 additions and 95 deletions.
41 changes: 0 additions & 41 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

106 changes: 106 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
name: Bug Report
description: Create a report to help us improve the integration
labels: [bug]
body:
- type: checkboxes
id: terms
attributes:
label: Did you read the instructions?
description: We have a high load of issue reports, thus we would like to ask you to read a few instructions first.
options:
- label: I have read the [README](https://github.com/iMicknl/ha-tahoma/blob/master/README.md), including the [advanced debugging](https://github.com/iMicknl/ha-tahoma/blob/master/README.md#advanced) section.
required: true

- type: textarea
validations:
required: true
attributes:
label: The problem
description: >-
Describe the issue you are experiencing here to communicate to the
maintainers. Tell us what you were trying to do and what happened.
Provide a clear and concise description of what the problem is. What did you expect to happen?
- type: markdown
attributes:
value: |
## Environment
- type: input
id: version
validations:
required: true
attributes:
label: What version of this integration (ha-tahoma) has the issue?
placeholder: 2.5.0
description: >
Can be found in the Configuration panel -> Info.
- type: input
id: ha_version
validations:
required: true
attributes:
label: What version of Home Assistant Core has the issue?
placeholder: core-
description: >
Can be found in the Configuration panel -> Info.
- type: markdown
attributes:
value: |
## Device
- type: input
id: overkiz_hub
validations:
required: true
attributes:
label: Which gateway / hub do you use?
placeholder: e.g. Somfy TaHoma or Cozytouch
description: >
Can be found in the Configuration panel -> Integrations -> Somfy TaHoma -> (x) devices
- type: input
id: overkiz_device_model
validations:
required: true
attributes:
label: Device model
placeholder: e.g. PositionableScreen
description: >
Can be found in the Configuration panel -> Integrations -> Somfy TaHoma -> (x) devices -> Model.
- type: input
id: overkiz_device_type
validations:
required: true
attributes:
label: Device type
placeholder: e.g. io:DimmableLightIOComponent
description: >
Can be found in the Configuration panel -> Integrations -> Somfy TaHoma -> (x) devices. Click on the device and copy the firmware.
- type: markdown
attributes:
value: |
## Details
- type: textarea
id: additional-information
attributes:
label: Additional information
description: If you have any additional information for us, use the field below. Please note, you can attach screenshots or screen recordings here, by dragging and dropping files in the field below.

- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell

- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Home Assistant Community forum
url: https://community.home-assistant.io/t/tahoma-integration-refactored/202025/last
about: Please ask and answer questions here.
21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

74 changes: 74 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
name: Feature request
description: Suggest an idea for this project
labels: [enhancement]
body:
- type: checkboxes
id: terms
attributes:
label: Did you read the instructions?
description: We have a high load of issue reports, thus we would like to ask you to read a few instructions first.
options:
- label: I have read the [README](https://github.com/iMicknl/ha-tahoma/blob/master/README.md), including the [advanced debugging](https://github.com/iMicknl/ha-tahoma/blob/master/README.md#advanced) section.
required: true

- type: textarea
validations:
required: true
attributes:
label: The request
description: >-
Describe your feature request here to communicate to the
maintainers. Tell us what you were trying to do and why.
Provide a clear and concise description of what the feature request is. What would you like to happen?
- type: markdown
attributes:
value: |
## Device
- type: input
id: overkiz_hub
validations:
required: true
attributes:
label: Which gateway / hub do you use?
placeholder: e.g. Somfy TaHoma or Cozytouch
description: >
Can be found in the Configuration panel -> Integrations -> Somfy TaHoma -> (x) devices
- type: input
id: overkiz_device_model
validations:
required: false
attributes:
label: Device model (optional)
placeholder: e.g. PositionableScreen
description: >
Can be found in the Configuration panel -> Integrations -> Somfy TaHoma -> (x) devices -> Model.
- type: input
id: overkiz_device_type
validations:
required: false
attributes:
label: Device type (optional)
placeholder: e.g. io:DimmableLightIOComponent
description: >
Can be found in the Configuration panel -> Integrations -> Somfy TaHoma -> (x) devices. Click on the device and copy the firmware.
- type: markdown
attributes:
value: |
## Details
- type: textarea
id: additional-information
attributes:
label: Additional information
description: If you have any additional information for us, use the field below. Please note, you can attach screenshots or screen recordings here, by dragging and dropping files in the field below.

- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request!
32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/unsupported-device.md

This file was deleted.

65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/unsupported_device.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: Unsupported Device
description: Let's have a look if we can support your device
title: "Add support for ModelName (io:SomfySensorName)"
labels: [new-device]
body:
- type: checkboxes
id: terms
attributes:
label: Did you read the instructions?
description: We have a high load of issue reports, thus we would like to ask you to read a few instructions first.
options:
- label: I have read the [README](https://github.com/iMicknl/ha-tahoma/blob/master/README.md), including the [advanced debugging](https://github.com/iMicknl/ha-tahoma/blob/master/README.md#advanced) section.
required: true

- type: textarea
validations:
required: true
attributes:
label: Device information
description: >-
Try to add a clear and concise description of the device, together with specific usecases that you would like to have supported.
- type: markdown
attributes:
value: |
## Device
- type: textarea
id: unsupported_device_log
attributes:
label: Unsupported device log
description: Enable [debug logging](https://github.com/iMicknl/ha-tahoma#enable-debug-logging) and paste the Unsupported device string here. If your device already shows up in Home Assistant, share the firwmare (e.g. `io:DimmableLightIOComponent`), which can be gathered from device detail page.
render: shell
validations:
required: true

- type: textarea
id: device_command_log
attributes:
label: Device commands
description: In order to gather more information, you can use the `tahoma.get_execution_history` service which will print your execution history to the Home Assistant log. Run the commands via the official vendor app (e.g. TaHoma) and capture the commands. [Read more](https://github.com/iMicknl/ha-tahoma#device-not-working-correctly).
render: shell

- type: markdown
attributes:
value: |
## Details
- type: textarea
id: additional-information
attributes:
label: Additional information
description: If you have any additional information for us, use the field below. Please note, you can attach screenshots or screen recordings here, by dragging and dropping files in the field below.

- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell

- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this request!
1 change: 0 additions & 1 deletion .github/workflows/stale.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# yamllint disable rule:line-length
name: Mark stale issues and pull requests

on:
Expand Down
Loading

0 comments on commit baf3aac

Please sign in to comment.