4
0
Эх сурвалжийг харах

Bug report template: emphasize the need for logs

- direct users to discussion #522 for connection issues.
- add a tickbox, but loosen the requirements as not all are always relevant.
Lately quality of bug reports has slipped, as users just tick the boxes
without thinking what they are agreeing to.
Jason Rumney 1 жил өмнө
parent
commit
0297d94d9c

+ 9 - 4
.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -5,12 +5,14 @@ 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.
+        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 reporting a device which is listed as supported, but cannot be added, please include the WARNING log message that contains a dps list, which is output during the detection stage. If you are not getting such a message, please see discussion \#522 for hints on resolving connection issues.
+
         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
@@ -58,12 +60,15 @@ body:
       description: |
         Please select if the following are applicable
       options:
-        - label: I am sure this is a bug, or improvement that is well enough described that it can be implemented
+        - label: I am sure this is a bug or improvement, that is well enough described that it can be implemented.
           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: false
+        - label: |
+            Log messages or diagnostics relevant to the issue are included.
+          required: false
+        - label: This is not requesting addition of a new device.
           required: true
     validations:
       required: true