bug_report.yaml 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. name: Bug report
  2. description: Report a bug with the integration or an existing device
  3. labels: ["bug"]
  4. body:
  5. - type: markdown
  6. attributes:
  7. value: |
  8. 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.
  9. **If you are reporting a deprecation message from the log, please check that the message is for an HA deprecation (telling you to report the issue here), and that there is not already [a bug](https://github.com/make-all/tuya-local/issues?q=is%3Aissue+is%3Aopen+label%3Amaintenance) for the issue.** Most likely the deprecation is new in the latest HA release, and will not be "fixed" in the integration until late in the month or the next month, as fixes generally are not backwards compatible with older HA versions. Other deprecation messages can be aimed at you, the end user, to prompt you to update automations etc. If the message is telling you an entity is deprecated, then you can disable the entity in Settings / Devices once you have adapted to use the replacement.
  10. 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.
  11. 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.
  12. 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.
  13. 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.
  14. - type: textarea
  15. id: description
  16. attributes:
  17. label: Description
  18. description: |
  19. A clear and concise description of the bug you are experiencing.
  20. validations:
  21. required: true
  22. - type: textarea
  23. id: steps
  24. attributes:
  25. label: Steps to reproduce
  26. description: |
  27. List any steps you need to take to reproduce this problem.
  28. placeholder: 1. Perform the ___ action...
  29. validations:
  30. required: false
  31. - type: textarea
  32. id: expected
  33. attributes:
  34. label: Expected behaviour
  35. description: |
  36. A clear and concise description of what you expected.
  37. placeholder: The device should...
  38. validations:
  39. required: false
  40. - type: textarea
  41. id: context
  42. attributes:
  43. label: Additional context
  44. description: |
  45. Please add additional context such as logs or device diagnostics here to help the developers understand what exactly is happening under the covers.
  46. Logs can be viewed under `Settings / System / Logs`
  47. Diagnostics can be downloaded from `Settings / Devices & Services / 1 device` under the relevant device.
  48. If applicable, you can also add screenshots to explain your problem.
  49. validations:
  50. required: false
  51. - type: checkboxes
  52. id: confirm
  53. attributes:
  54. label: Confirmation
  55. description: |
  56. Please select if the following are applicable
  57. options:
  58. - label: I am sure this is a bug or improvement, that is well enough described that it can be implemented.
  59. required: true
  60. - label: This report is for tuya-local, **not** for localtuya.
  61. required: true
  62. - label: |
  63. If this is for a specific device, the device config filename is mentioned above, or diagnostics are included.
  64. required: false
  65. - label: |
  66. Log messages or diagnostics relevant to the issue are included.
  67. required: false
  68. - label: This is not requesting addition of a new device.
  69. required: true
  70. validations:
  71. required: true