Dev

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,6 +1,6 @@
-name: Econet300 Integration Bug Report
+name: Report an issue with Econet300 home assistant integration
 description: Report an issue with Econet300 home assistant integration.
-title: "[Bug]: <short description>"
+title: "[Bug]: "
 labels: ["bug", "triage"]
 assignees:
   - jontofront
@@ -9,49 +9,21 @@ body:
     attributes:
       value: |
         This issue form is for reporting bugs only!
+
         If you have a feature or enhancement request, please use the feature request issue type.
+
         [feature request]: https://github.com/jontofront/ecoNET-300-Home-Assistant-Integration/issues/new/choose
+
   - type: textarea
-    id: title
-    attributes:
-      label: Bug Title
-      description: A brief description of the bug.
-      placeholder: "Enter the bug title here"
-  - type: textarea
-    id: problem_description
     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.
-  - type: checkboxes
-    attributes:
-      label: "Connected devices"
-      description: "I have the following devices connected. For more information, see [ecoNET300_DTR_1.0_ENG](https://thermostahl.ro/wp-content/uploads/2020/08/ecoNET300_DTR_1.0_ENG.pdf)."
-    options:
-      - label: ecoMAX800 series
-      - label: ecoMAX850 series
-      - label: ecoMAX860 series
-      - label: ecoSTER
-      - label: ecoNET 300
-    validations:
-      required: true
-  - type: dropdown
-    id: series
-    attributes:
-      label: Affected Series
-      description: Select the series of the ecoMAX controller affected by this bug.
-      options:
-        - label: Select a series
-        - label: ecoMAX800 series
-          description: "ecoMAX800 series controllers"
-        - label: ecoMAX850 series
-          description: "ecoMAX850 series controllers"
-        - label: ecoMAX860 series
-          description: "ecoMAX860 series controllers"
   - type: markdown
     attributes:
       value: |
@@ -61,36 +33,38 @@ body:
     validations:
       required: true
     attributes:
-      label: What version of Econet300 integration has the issue?
+      label: What version of ecoNET300 integration has the issue?
   - 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 System information section of Home Assistant.
-        [Open your Home Assistant instance and show the system information.](https://my.home-assistant.io/redirect/system_health/)
+        Can be found in: [Settings ⇒ System ⇒ Repairs ⇒ Three Dots in Upper Right ⇒ System information](https://my.home-assistant.io/redirect/system_health/).
+
         [![Open your Home Assistant instance and show the system information.](https://my.home-assistant.io/badges/system_health.svg)](https://my.home-assistant.io/redirect/system_health/)
   - type: input
-    id: last_working_version
     attributes:
-      label: What was the last working version of Econet300 integration?
+      label: What was the last working version of ecoNET300 integration?
       description: >
         If known, otherwise leave blank.
+
   - type: markdown
     attributes:
       value: |
         # Details
   - type: textarea
-    id: diagnostics
     attributes:
       label: Diagnostics information
-      placeholder: "Drag-and-drop diagnostics data file here"
+      placeholder: "drag-and-drop the diagnostics data file here (do not copy-and-paste the content)"
       description: >-
         Follow HA guide to [download diagnostic data](https://www.home-assistant.io/docs/configuration/troubleshooting/#debug-logs-and-diagnostics).
+
         **It would really help if you could download the diagnostics data for the device you are having issues with,
         and <ins>drag-and-drop that file into the textbox below.</ins>**
+
         It generally allows pinpointing defects and thus resolving issues faster.
   - type: textarea
     attributes:

.github/ISSUE_TEMPLATE/bug_report_new.yaml

@@ -0,0 +1,113 @@
+name: HA Econet300 Integration Bug Report
+title: '"[Bug]: <short description>"'
+description: Report an issue with Econet300 home assistant integration.
+body:
+  - type: markdown
+    attributes:
+      value: >-
+        This issue form is for reporting bugs only!
+        If you have a feature or enhancement request, please use the feature request issue type.
+        [feature request]: https://github.com/jontofront/ecoNET-300-Home-Assistant-Integration/issues/new/choose
+
+  - type: input
+    id: bug_title
+    attributes:
+      label: Bug Title
+      description: A brief description of the bug.
+      placeholder: "Enter the bug title here"
+
+  - type: textarea
+    id: problem_description
+    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.
+      placeholder: "Enter the problem description here"
+
+  - type: checkboxes
+    id: connected_devices
+    attributes:
+      label: Connected devices
+      description: I have the following devices connected. For more information, see
+        [ecoNET300_DTR_1.0_ENG](https://thermostahl.ro/wp-content/uploads/2020/08/ecoNET300_DTR_1.0_ENG.pdf)
+      options:
+        - label: ecoMAX800 series
+        - label: ecoMAX850 series
+        - label: ecoMAX860 series
+        - label: ecoSTER
+        - label: ecoNET 300
+    validations:
+      required: true
+
+  - type: input
+    id: econet300_version
+    attributes:
+      label: What version of Econet300 integration has the issue?
+      placeholder: "Enter the version here"
+
+  - type: textarea
+    id: steps_to_reproduce
+    attributes:
+      label: Steps to Reproduce
+      description: Detailed steps to reproduce the bug.
+      placeholder: "Enter the steps to reproduce the bug here"
+
+  - type: textarea
+    id: expected_behavior
+    attributes:
+      label: Expected Behavior
+      description: Describe what you expected to happen.
+      placeholder: "Enter the expected behavior here"
+
+  - type: textarea
+    id: actual_behavior
+    attributes:
+      label: Actual Behavior
+      description: Describe what actually happened.
+      placeholder: "Enter the actual behavior here"
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Logs
+      description: Include any relevant logs or error messages.
+      placeholder: "Enter the logs or error messages here"
+
+  - type: input
+    id: ha_version
+    validations:
+      required: true
+    attributes:
+      label: What version of Home Assistant Core has the issue?
+      description: >
+        Can be found in the System information section of Home Assistant.
+
+        [Open your Home Assistant instance and show the system information.](https://my.home-assistant.io/redirect/system_health/)
+        [![Open your Home Assistant instance and show the system information.](https://my.home-assistant.io/badges/system_health.svg)](https://my.home-assistant.io/redirect/system_health/)
+
+  - type: input
+    id: last_working_version
+    attributes:
+      label: What was the last working version of Econet300 integration?
+      description: >
+        If known, otherwise leave blank.
+
+  - type: markdown
+    attributes:
+      value: |
+        # Details
+
+  - type: textarea
+    id: diagnostics
+    attributes:
+      label: Diagnostics information
+      placeholder: "Drag-and-drop diagnostics data file here"
+      description: >-
+        Follow HA guide to [download diagnostic data](https://www.home-assistant.io/docs/configuration/troubleshooting/#debug-logs-and-diagnostics).
+
+        **It would really help if you could download the diagnostics data for the device you are having issues with,
+        and <ins>drag-and-drop that file into the textbox below.</ins>**
+
+        It generally allows pinpointing defects and thus resolving issues faster.