chore(github): update issue template (#360)

* chore(github): update issue template --------- Co-authored-by: Simone Chemelli <[email protected]>
wuwentao · Oct 10, 2024 · bcf13fa · bcf13fa
1 parent 3a4e35b
commit bcf13fa
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 11 deletions.
diff --git a/.github/ISSUE_TEMPLATE/1-issue_zh-cn.yml b/.github/ISSUE_TEMPLATE/1-issue_zh-cn.yml
@@ -1,5 +1,5 @@
 ---
-name: 错误报告
+name: 错误Bug报告
 description: 集成或实体无法正常工作
 labels: ["bug"]
 body:
@@ -37,8 +37,20 @@ body:
     validations:
       required: true
     attributes:
-      label: 问题详细描述
+      label: 问题/Bug详细描述
+      description: 请准确描述问题对应的设备和操作
+      value: |
+        1. 请准确描述问题对应的设备名称、类型（尤其是log里面有一堆设备，到底哪个设备的什么操作有问题，务必准确说明）
+        2. 请准确描述有问题的操作或错误提示信息，例如操作xxx，实际是yyy等，（禁止提交XXX不能用了，XXX不行了）
   - type: textarea
     attributes:
       label: The logs
-      description: 必须开启Debug Log，并执行发生错误的操作，将发生错误时的Debug log文件以附件上传，开启debug log方法参考首页README
+      description: 必须先开启Debug Log(参考首页README)，并执行产生错误的操作，将完整的Debug log文件以附件上传（请勿粘贴log中内容)
+      value: |
+        1. 必须先开启Debug Log(参考首页README说明)
+        2. 执行产生错误的操作（请务必在问题详细描述中说明）
+        3. 将完整的Debug log文件以附件上传。
+        4. 请勿直接粘贴log中的部分内容！以附件上传。
+        5. 请勿直接粘贴log中的部分内容！以附件上传。
+        6. 请勿直接粘贴log中的部分内容!以附件上传。
+        ...
diff --git a/.github/ISSUE_TEMPLATE/2-issue_en.yml b/.github/ISSUE_TEMPLATE/2-issue_en.yml
@@ -38,8 +38,20 @@ body:
     validations:
       required: true
     attributes:
-      label: The description of problem
+      label: The detail description of bug/problem
+      description: description the device type and the error details
+      value: |
+        1. description the device type and name（you may have multiple devices）
+        2. description the error action or error info (device have multiple data/features)
   - type: textarea
     attributes:
       label: The logs
       description: DEBUG log MUST be enabled, and execute the action to trigger error log and upload the debug log file as attachment. please refer to README document to enable DEBUG log
+      value: |
+        1. DEBUG log MUST be enabled (Please refer to README document)
+        2. Execute the action to trigger error log（you should description the error action）
+        3. Upload the debug log file as attachment。
+        4. Please don't paste the log content! upload as a attachment file.
+        5. Please don't paste the log content! upload as a attachment file.
+        6. Please don't paste the log content! upload as a attachment file.
+        ...
diff --git a/.github/ISSUE_TEMPLATE/3-enhancement_zh-cn.yml b/.github/ISSUE_TEMPLATE/3-enhancement_zh-cn.yml
@@ -7,15 +7,22 @@ body:
     validations:
       required: true
     attributes:
-      label: 设备类型及型号 (或SN)
+      label: 设备类型及型号 (SN)
       placeholder: Air Conditioner 22012225
       description: |
         > 设备型号可以在 配置 -> 设备与服务 -> Midea AC LAN -> 设备 -> 设备信息 找到
         > SN可以在 配置 -> 设备与服务 -> Midea AC LAN -> 添加设备 -> Just list appliances 找到
-        > 出于隐私原因, 你应该将SN后10个字节隐藏
-        > 如将"0000BF31163200988193162YLW17116Y"替换成"0000BF3116320098819316XXXXXXXXXX"
+        > SN也可以在美居app的设备信息中查看
+      value: |
+        > 设备型号可以在 配置 -> 设备与服务 -> Midea AC LAN -> 设备 -> 设备信息 找到
+        > SN可以在 配置 -> 设备与服务 -> Midea AC LAN -> 添加设备 -> Just list appliances 找到
+        > SN也可以在美居app的设备信息中查看
   - type: textarea
     validations:
       required: true
     attributes:
-      label: 新功能的描述
+      label: 新功能的具体描述
+      value: |
+        1. 新增设备支持：希望支持的设备类型以及具体功能，例如查看状态、控制某个功能等
+        2. 已有设备新增功能支持：app中可以查看数据，可以控制某个功能，目前不支持，请准确描述
+        3. 其他：请准确描述清楚
diff --git a/.github/ISSUE_TEMPLATE/4-enhancement_en.yml b/.github/ISSUE_TEMPLATE/4-enhancement_en.yml
@@ -12,10 +12,17 @@ body:
       description: |
         > The model can be found in Settings -> Devices & Services -> Midea AC LAN -> Devices -> Device Info
         > The SN can be found in Settings -> Devices & Services -> Midea AC LAN -> Add device -> Just list appliances
-        > For privacy reason, You should mask the last 10 bytes of the SN.
-        > e.g., replace "0000BF31163200988193162YLW17116Y" with "0000BF3116320098819316XXXXXXXXXX"
+        > The SN also can be found in your SmartHome APP
+      value: |
+        > The model can be found in Settings -> Devices & Services -> Midea AC LAN -> Devices -> Device Info
+        > The SN can be found in Settings -> Devices & Services -> Midea AC LAN -> Add device -> Just list appliances
+        > The SN also can be found in your SmartHome APP
   - type: textarea
     validations:
       required: true
     attributes:
-      label: The description of new feature
+      label: The detail description of new feature
+      value: |
+        1. support new device : description device type and features you want to support
+        2. support new feature: description the feature details with device type and details
+        3. others: description the details