Просмотр исходного кода

Bug templates: don't break long lines

Descriptions seem to interpret line breaks as intended, and do not
re-wrap paragraphs.
Jason Rumney 1 год назад
Родитель
Сommit
21de0f39e1
2 измененных файлов с 14 добавлено и 40 удалено
  1. 7 21
      .github/ISSUE_TEMPLATE/bug_report.yaml
  2. 7 19
      .github/ISSUE_TEMPLATE/new-device.yaml

+ 7 - 21
.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -5,23 +5,13 @@ 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 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 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.
+        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
@@ -54,12 +44,9 @@ body:
     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.
+        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
+        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:
@@ -74,8 +61,7 @@ body:
         - 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.
+            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

+ 7 - 19
.github/ISSUE_TEMPLATE/new-device.yaml

@@ -6,13 +6,9 @@ body:
   - type: markdown
     attributes:
       value: |
-        This form is for reporting a **New Device**.  If you are looking for
-        general help, including cases where you do not see anything in the log,
-        see [Discussions](https://github.com/make-all/tuya-local/discussions).
+        This form is for reporting a **New Device**.  If you are looking for general help, including cases where you do not see anything in the log, see [Discussions](https://github.com/make-all/tuya-local/discussions).
 
-        Thank you for reporting your unsupported device. Please provide as
-        much information as you can. Because the developers are busy, new
-        device requests will be prioritised as follows:
+        Thank you for reporting your unsupported device. Please provide as much information as you can. Because the developers are busy, new device requests will be prioritised as follows:
 
           1. Pull requests
           2. Issues with logs and QueryThingsDataModel API results or equivalent
@@ -24,9 +20,7 @@ body:
     attributes:
       label: Log message
       description: |
-        Please paste the Warning level log message containing a dps list
-        which is output when you attempt to add the device and are presented
-        with a list of non-matching devices.
+        Please paste the Warning level log message containing a dps list which is output when you attempt to add the device and are presented with a list of non-matching devices.
       placeholder: Reports without logs will be immediately closed
       render: text
     validations:
@@ -37,10 +31,7 @@ body:
       label: DPS information
       description: |
         Preferred data is QueryThingsDataModel API result from iot.tuya.com
-        If you do not have access to iot.tuya.com, but have other ways of
-        obtaining dps information, the minimum info required is the numeric
-        dp id, name/description, data type, and for settable dps, the range
-        for numeric dps, and the list of possible values for enum dps.
+        If you do not have access to iot.tuya.com, but have other ways of obtaining dps information, the minimum info required is the numeric dp id, name/description, data type, and for settable dps, the range for numeric values, and the list of possible values for enum values.
       render: text
     validations:
       required: true
@@ -49,9 +40,8 @@ body:
     attributes:
       label: Product ID
       description: |
-        The product ID or productKey for the device. You can get this
-        from the same iot.tuya.com API functions that provide the local key
-        or from `tinytuya scan` or other tools doing local discovery
+        The product ID or productKey for the device.
+        You can get this from the same iot.tuya.com API functions that provide the local key or from `tinytuya scan` or other tools doing local discovery
   - type: input
     id: productname
     attributes:
@@ -62,6 +52,4 @@ body:
     attributes:
       label: Information about how the device functions
       description: |
-        Put any additional information here.  Remember the developers are not
-        familiar with your device, so any explanations of how it functions,
-        links to manuals or even marketing webpages are useful.
+        Put any additional information here.  Remember the developers are not familiar with your device, so any explanations of how it functions, links to manuals or even marketing webpages are useful.