From baf3aac47385fe55463c8a0b0eaf0c5d8565da83 Mon Sep 17 00:00:00 2001 From: Mick Vleeshouwer Date: Wed, 14 Jul 2021 16:31:44 -0700 Subject: [PATCH] Update issue reports to use GitHub template (#475) --- .github/ISSUE_TEMPLATE/bug_report.md | 41 ------- .github/ISSUE_TEMPLATE/bug_report.yml | 106 ++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 + .github/ISSUE_TEMPLATE/feature_request.md | 21 ---- .github/ISSUE_TEMPLATE/feature_request.yml | 74 ++++++++++++ .github/ISSUE_TEMPLATE/unsupported-device.md | 32 ------ .github/ISSUE_TEMPLATE/unsupported_device.yml | 65 +++++++++++ .github/workflows/stale.yml | 1 - .yamllint | 61 ++++++++++ 9 files changed, 311 insertions(+), 95 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/unsupported-device.md create mode 100644 .github/ISSUE_TEMPLATE/unsupported_device.yml create mode 100644 .yamllint diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 869c3617f..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "" -labels: bug -assignees: "" ---- -- [ ] **I have read the [Readme](https://github.com/iMicknl/ha-tahoma/blob/master/README.md), including the [Advanced](https://github.com/iMicknl/ha-tahoma/blob/master/README.md#advanced) section regarding debugging.** - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Environment (please complete the following information):** - -- **Hub**: [e.g. Cozytouch, eedoums, Hi Kumo, Rexel, Somfy Connexoon, Somfy TaHoma] -- **ha-tahoma version:** [e.g. 2.0.0] -- **Home Assistant version:** [e.g. 0.110.4] -- **Platform**: [e.g. cover, sensor, binary_sensor] - -**Device:** (if your problem is related to a specific device) - -- **Model**: [e.g. PositionableScreen, can be gathered from device list in HA] -- **Type**: [e.g. `io:DimmableLightIOComponent`, can be gathered from device page in HA looking at Firmware] `/config/devices/dashboard`] - -**Additional context** - -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..2edb17366 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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! diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..41e7de151 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index e61f5b43b..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: enhancement -assignees: '' - ---- -- [ ] **I have read the [README](https://github.com/iMicknl/ha-tahoma/blob/master/README.md), including the [Advanced](https://github.com/iMicknl/ha-tahoma/blob/master/README.md#advanced) section regarding debugging.** - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..c3a8e5b38 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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! diff --git a/.github/ISSUE_TEMPLATE/unsupported-device.md b/.github/ISSUE_TEMPLATE/unsupported-device.md deleted file mode 100644 index 72e01cb8f..000000000 --- a/.github/ISSUE_TEMPLATE/unsupported-device.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: Unsupported device -about: Let's have a look if we can add support for your device to this component -title: Add support for ModelName (io:SomfySensorName) -labels: new-device -assignees: "" ---- -- [ ] **I have read the [README](https://github.com/iMicknl/ha-tahoma/blob/master/README.md), including the [advanced](https://github.com/iMicknl/ha-tahoma/blob/master/README.md#advanced) section regarding debugging.** - - - -**Device information** -A clear and concise description of the device, together with specific usecases that you would like to see supported. - - -**Device details** - -- **Hub**: [e.g. Cozytouch, eedoums, Hi Kumo, Rexel, Somfy Connexoon, Somfy TaHoma] - - - -**Device commands** - diff --git a/.github/ISSUE_TEMPLATE/unsupported_device.yml b/.github/ISSUE_TEMPLATE/unsupported_device.yml new file mode 100644 index 000000000..16b1875dd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/unsupported_device.yml @@ -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! diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index 074b2773d..dc5b4f36b 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -1,4 +1,3 @@ - # yamllint disable rule:line-length name: Mark stale issues and pull requests on: diff --git a/.yamllint b/.yamllint new file mode 100644 index 000000000..f7cd7c65a --- /dev/null +++ b/.yamllint @@ -0,0 +1,61 @@ +ignore: | + .github +rules: + braces: + level: error + min-spaces-inside: 0 + max-spaces-inside: 1 + min-spaces-inside-empty: -1 + max-spaces-inside-empty: -1 + brackets: + level: error + min-spaces-inside: 0 + max-spaces-inside: 0 + min-spaces-inside-empty: -1 + max-spaces-inside-empty: -1 + colons: + level: error + max-spaces-before: 0 + max-spaces-after: 1 + commas: + level: error + max-spaces-before: 0 + min-spaces-after: 1 + max-spaces-after: 1 + comments: + level: error + require-starting-space: true + min-spaces-from-content: 2 + comments-indentation: + level: error + document-end: + level: error + present: false + document-start: + level: error + present: false + empty-lines: + level: error + max: 1 + max-start: 0 + max-end: 1 + hyphens: + level: error + max-spaces-after: 1 + indentation: + level: error + spaces: 2 + indent-sequences: true + check-multi-line-strings: false + key-duplicates: + level: error + line-length: disable + new-line-at-end-of-file: + level: error + new-lines: + level: error + type: unix + trailing-spaces: + level: error + truthy: + level: warning