Updated issue templates

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -1,51 +1,125 @@
 name: 🐞 Bug report
 description: "Report a bug or something that is otherwise not working as expected."
 labels: ["bug"]
+
 body:
-- type: textarea
-  id: description
-  attributes:
-    label: Description of Issue
-    description: "Please provide a clear and concise description of the bug below."
-  validations:
-    required: true
-- type: input
-  id: version
-  attributes:
-    label: Plugin Version
-    description: "Please state the version number of this plugin that exhibits the bug. If this is not the most recent release then please try updating to the latest version before reporting the issue."
-  validations:
-    required: true
-- type: input
-  id: appliance
-  attributes:
-    label: AEG/Electrolux Appliance(s)
-    description: "If this issue relates to a specific appliance then please provide the manufacturer, model, and product number (PNC). These details can be found on the ratings label underneath the robot."
-    placeholder: "e.g. AEG RX9-2-4ANM 900 277 479"
-  validations:
-    required: false
-- type: input
-  id: homekitapp
-  attributes:
-    label: HomeKit App(s)
-    description: "If this issue relates to a specific HomeKit app then please provide details."
-    placeholder: "e.g. Apple Home, Elgato Eve, Home+ 4, Hesperus, etc."
-  validations:
-    required: false
-- type: checkboxes
-  id: diagnostics
-  attributes:
-    label: Diagnostic Checks
-    description: "Indicate the steps that have you have taken to rule-out problems with the AEG/Electrolux servers or appliance."
-    options:
-      - label: "AEG iPhone app is able to control the appliance."
-  validations:
-    required: false
-- type: textarea
-  id: log
-  attributes:
-    label: Log File
-    description: "Please copy/paste relevant log entries. Attach longer logs as a text file. Do NOT use a screenshot. These logs should be captured with Homebridge in debug mode (enabled using its -D command line option)."
-    render: shell
-  validations:
-    required: false
+  - type: textarea
+    id: description
+    attributes:
+      label: Description of Issue
+      description: "Provide a clear and concise description of the bug."
+      placeholder: "Describe the bug..."
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behaviour
+      description: "What did you expect to happen?"
+      placeholder: "Describe the expected outcome..."
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Steps to Reproduce
+      description: "Provide a step-by-step description of how to reproduce the issue."
+      placeholder: |
+        Steps to reproduce:
+        1. ...
+        2. ...
+    validations:
+      required: true
+
+  - type: input
+    id: version
+    attributes:
+      label: Plugin Version
+      description: "State the plugin version exhibiting the bug. If not using the latest version, please update before reporting."
+    validations:
+      required: true
+
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment
+      description: |
+        Describe the software environment being used to run this plugin. Include:
+        - Operating System type and version (output of `lsb_release -d` on Linux)
+        - Node.js version (output of `node -v`)
+        - Homebridge version (output of `npm -g ls homebridge`)
+      placeholder: |
+        - OS: e.g. Ubuntu 24.04.1 LTS or macOS Ventura 13.5
+        - Node: e.g. v18.20.4
+        - Homebridge: e.g. 1.8.5
+    validations:
+      required: true
+
+  - type: input
+    id: appliance
+    attributes:
+      label: AEG/Electrolux Appliance(s)
+      description: "Provide the appliance manufacturer, model, and product number (if applicable). These details can be found on the ratings label underneath the robot."
+      placeholder: "e.g. AEG RX9-2-4ANM 900 277 479"
+    validations:
+      required: false
+
+  - type: input
+    id: homekitapp
+    attributes:
+      label: HomeKit App(s)
+      description: "Provide details about the HomeKit app involved (if applicable)."
+      placeholder: "e.g. Apple Home, Elgato Eve, Home+ 4, Hesperus, etc."
+    validations:
+      required: false
+
+  - type: checkboxes
+    id: diagnostics
+    attributes:
+      label: Diagnostic Checks
+      description: "Indicate steps you have taken to rule out other causes."
+      options:
+        - label: "AEG iPhone app is able to control the appliance."
+        - label: "Searched for [previously reported issues](https://github.com/thoukydides/homebridge-aeg-robot/issues?q=is%3Aissue) and found none."
+    validations:
+      required: false
+
+  - type: textarea
+    id: log
+    attributes:
+      label: Log File
+      description: "Provide relevant logs, captured with Homebridge in debug mode (`-D`). Attach longer logs as a text file. Ensure logs are complete and legible. Do NOT use a screenshot. Replace sensitive information like access tokens with `REDACTED`."
+      placeholder: "Paste logs captured using: homebridge -D > debug.log"
+      render: shell
+    validations:
+      required: true
+
+  - type: textarea
+    id: config
+    attributes:
+      label: Configuration
+      description: "Provide your `config.json` (if relevant). Replace sensitive information (Client ID, passwords, tokens, etc) with `REDACTED`. This is optional but highly recommended."
+      placeholder: "Paste configuration..."
+      render: json
+    validations:
+      required: false
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional Information
+      description: "Provide any additional information that might assist with resolving your bug report. This could include links to product web pages, user manuals, screenshots, or anything else relevant."
+      placeholder: "Any other relevant information..."
+    validations:
+      required: false
+
+  - type: markdown
+    attributes:
+      value: |
+        **Important Notes:**
+        - Ensure all required fields are filled.
+        - Debug logs (`-D` mode) are crucial for resolving most issues.
+        - Remove sensitive information (e.g., passwords or tokens) from logs.
+        - If you are not using the most recent plugin version, update before submitting.

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -1,26 +1,49 @@
 name: 🚧 Feature request
 description: Suggest a new feature or other enhancement.
 labels: ["enhancement"]
+
 body:
-- type: textarea
-  id: description
-  attributes:
-    label: Description of Enhancement
-    description: "Please provide a clear and concise description of your proposed improvement."
-  validations:
-    required: true
-- type: textarea
-  id: hapmap
-  attributes:
-    label: HomeKit Mapping
-    description: "Please suggest how the requested functionality can be supported using the Apple-defined services and characteristics listed in the [HomeKit Accessory Protocol Specification (Non-Commercial Version)](https://developer.apple.com/apple-home/)."
-  validations:
-    required: false   
-- type: input
-  id: appliance
-  attributes:
-    label: AEG/Electrolux Appliance(s)
-    description: "If this issue relates to a specific appliance then please provide the manufacturer, model, and product number (PNC). These details can be found on the ratings label underneath the robot."
-    placeholder: "e.g. AEG RX9-2-4ANM 900 277 479"
-  validations:
-    required: false
+  - type: markdown
+    attributes:
+      value: "Please check [closed/rejected issues](https://github.com/thoukydides/homebridge-aeg-robot/issues?q=is%3Aissue) for any previous requests to implement similar functionality. Requests for additional configuration options to disable functionality, or inappropriate use of HomeKit services/characteristics, will be rejected."
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description of Enhancement
+      description: "Please provide a clear and concise description of your proposed improvement. Include specific use cases or examples where this enhancement would be beneficial."
+    validations:
+      required: true
+
+  - type: textarea
+    id: egmap
+    attributes:
+      label: Electrolux Group API
+      description: "Please suggest how the requested functionality can be supported using the functionality of the [Electrolux Group API](https://developer.electrolux.one/documentation/reference)."
+    validations:
+      required: false
+
+  - type: textarea
+    id: hapmap
+    attributes:
+      label: HomeKit Mapping
+      description: "Please suggest how the requested functionality can be supported using the Apple-defined services and characteristics listed in the [HomeKit Accessory Protocol Specification (Non-Commercial Version)](https://developer.apple.com/apple-home/)."
+    validations:
+      required: false
+
+  - type: input
+    id: appliance
+    attributes:
+      label: AEG/Electrolux Appliance(s)
+      description: "If this enhancement relates to a specific appliance then please provide the manufacturer, model, and product number (PNC). These details can be found on the ratings label underneath the robot."
+      placeholder: "e.g. AEG RX9-2-4ANM 900 277 479"
+    validations:
+      required: false
+
+  - type: markdown
+    attributes:
+      value: |
+        **Important Notes:**
+        - Feature requests must align with HomeKit's intended functionality and Electrolux Group API capabilities.
+        - Features outside the scope of HomeKit or Electrolux Group API are unlikely to be implemented.
+        - Detailed, actionable suggestions, are more likely to be considered.