Jason Rumney 1 год назад
Родитель
Сommit
fd6096a53a
2 измененных файлов с 81 добавлено и 38 удалено
  1. 0 38
      .github/ISSUE_TEMPLATE/bug_report.md
  2. 81 0
      .github/ISSUE_TEMPLATE/bug_report.yaml

+ 0 - 38
.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,38 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: 'bug'
-assignees: ''
-
----
-Please do not request support for new devices through this bug
-reporting link. Go back and choose "New Device" from the previous
-screen.
-
-This form is for reporting bugs.  If you have encountered a bug, you should
-generally have some log messages or device diagnostics to show something is
-going wrong.  If your problem is more of a question or a request for help,
-then [Discussions](https://github.com/make-all/tuya-local/discussions) is
-probably a more suitable venue.
-
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior including the device the issue was observed with:
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Additional context**
-Add any other context about the problem here.
-
-If the bug involves a device, then please include device diagnostics from
-Settings / Devices & Services / Tuya Local (your device) / "1 device"
-
-Please check if there are messages from Tuya Local in the Home
-Assistant log (Settings / System / Logs), and include those too.
-
-If applicable, add screenshots to help explain your problem.

+ 81 - 0
.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,81 @@
+name: Bug report
+description: Report a bug with the integration or an existing device
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        This form is for reporting bugs with the integration or existing
+        devices. Bug reports should be detailed with log messages or
+        device diagnostics to help developers determine what is going wrong.
+
+        If you have a question, or are unsure if what you observe is really
+        a bug, consider using
+        [Discussions](https://github.com/make-all/tuya-local/discussions)
+        instead.
+
+        If you are reporting an unsupported device, please use the
+        **New Device** reporting template instead, which will guide you
+        on the information required to make sure your request is not put into
+        the "too hard" pile.
+
+        If you are intending to create a pull request, an issue is not
+        required, but please clearly describe the reason for your PR in the
+        description of the PR.
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: |
+        A clear and concise description of the bug you are experiencing.
+      validations:
+        required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to reproduce
+      description: |
+        List any steps you need to take to reproduce this problem.
+      placeholder: 1. Perform the ___ action...
+      validations:
+        required: false
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behaviour
+      description: |
+        A clear and concise description of what you expected.
+      placeholder: The device should...
+      validations:
+        required: false
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: |
+        Please add additional context such as logs or device diagnostics here
+        to help the developers understand what exactly is happening under the
+        covers.
+        Logs can be viewed under `Settings / System / Logs`
+        Diagnostics can be downloaded from
+        `Settings / Devices & Services / 1 device` under the relevant device
+
+        If applicable, you can also add screenshots to explain your problem.
+      validations:
+        required: false
+  - type: checkboxes
+    id: confirm
+    attributes:
+      label: Confirmation
+      description: |
+        Please select if the following are applicable
+      options:
+        - label: I am sure this is a bug
+          required: true
+        - label: |
+            If this is for a specific device, the device config is
+            mentioned above, or diagnostics are included.
+          required: true
+        - label: This is not requesting addition of a new device
+          required: true