reviewed templates

nRF24 · Jul 8, 2024 · c25baa4 · c25baa4
1 parent a018cb1
commit c25baa4
Show file tree

Hide file tree

Showing 3 changed files with 72 additions and 44 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -7,7 +7,12 @@ body:
   - type: markdown
     attributes:
       value: |-
-        Please read [about common issues](https://github.com/nRF24/RF24/blob/master/COMMON_ISSUES.md) first.
+        [docs]: https://nRF24.github.io/RF24
+        [api-docs]: https://nrf24.github.io/RF24/classRF24.html
+        [common-issues]: https://github.com/nRF24/RF24/blob/master/COMMON_ISSUES.md
+        [platform-pages]: https://nrf24.github.io/RF24/pages.html
+
+        Please read [about common issues][common-issues] first.
         It addresses the most common problems that people have (whether they know it or not).
 
         > [!caution]
@@ -16,23 +21,22 @@ body:
         > - [Arduino Forums](https://forum.arduino.cc/)
         > - [PlatformIO forums](https://community.platformio.org/)
 
-        We also host exhaustive [library documentation](https://nRF24.github.io/RF24).
-        Please check the [API docs](https://nrf24.github.io/RF24/classRF24.html)
-        and/or [platform-specific pages](https://nrf24.github.io/RF24/pages.html)
-        to see if your problem is described or addressed there.
-
-        Python users should migrate to using our [pyRF24](https://github.com/nRF24/pyRF24) python package.
-
-        <details><summary>The pyRF24 package has numerous advantages over the older/individual python wrapper(s)</summary>
-
-        - [x] [drop-in compatible](https://nrf24.github.io/pyRF24/#migrating-to-pyrf24)
-        - [x] available via [`pip install pyrf24`](https://pypi.org/project/pyrf24/)
-        - [x] no need to build from source and does not require the C++ libraries installed
-        - [x] includes wrappers for RF24, RF24Network, RF24Mesh libraries and a fake BLE implementation
-        - [x] includes typing stubs for type checking tools like mypy
-        - [x] has [dedicated documentation](https://nrf24.github.io/pyRF24) and supports Python's builtin `help()` function
-
-        </details>
+        We also host exhaustive [library documentation][docs].
+        Please check the [API documentation][api-docs] or [platform support pages][platform-pages] to see if your question is addressed there.
+
+        > [!important]
+        > Python users should migrate to using our [pyRF24](https://github.com/nRF24/pyRF24) python package.
+        >
+        > <details><summary>The pyRF24 package has numerous advantages over the older/individual python wrapper(s)</summary>
+        >
+        > - [x] [drop-in compatible](https://nrf24.github.io/pyRF24/#migrating-to-pyrf24) API
+        > - [x] available via [`pip install pyrf24`](https://pypi.org/project/pyrf24/)
+        > - [x] no need to build from source and does not require the C++ libraries installed
+        > - [x] includes wrappers for RF24, RF24Network, RF24Mesh libraries and a fake BLE implementation
+        > - [x] includes typing stubs for type checking tools like mypy
+        > - [x] has [dedicated documentation](https://nrf24.github.io/pyRF24) and supports Python's builtin `help()` function
+        >
+        > </details>
 
   - type: input
     id: module
@@ -74,23 +78,32 @@ body:
         ```text
         uname -srm && lsb_release -a
         ```
+      placeholder: |-
+        Linux 6.6.28+rpt-rpi-v7 armv7l
+        No LSB modules are available.
+        Distributor ID:	Raspbian
+        Description:	Raspbian GNU/Linux 12 (bookworm)
+        Release:	12
+        Codename:	bookworm
       render: text
 
   - type: textarea
     id: user-issue
     attributes:
       label: Describe your problem
       description: Please use as much detail as possible.
-      placeholder: Something seems broken because ...
-    validation:
+      placeholder: You can use markdown syntax here
+    validations:
       required: true
 
   - type: markdown
     id: how-to-md
     attributes:
       value: |-
+        [gfm-doc]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
+
         GitHub supports their own flavor of MarkDown syntax.
-        Learn more in [GitHub's documentation](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).
+        Learn more about writing Markdown syntax in [GitHub's documentation][gfm-doc].
 
   - type: textarea
     id: rx-code
@@ -110,6 +123,6 @@ body:
       description: >-
         Use this area to show your relevant source code for TX behavior.
       value: |-
-        #include <RF24.h>
-        // ...
+        // The code for RX is same for TX.
+        // See above code for RX
       render: cpp
diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml
@@ -35,3 +35,12 @@ body:
       description: >-
         If there is anything that might be special or specific to your usage, please let us know.
       placeholder: You can use markdown syntax here
+
+  - type: markdown
+    id: how-to-md
+    attributes:
+      value: |-
+        [gfm-doc]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
+
+        GitHub supports their own flavor of MarkDown syntax.
+        Learn more about writing Markdown syntax in [GitHub's documentation][gfm-doc].
diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml
@@ -9,45 +9,51 @@ body:
   - type: markdown
     attributes:
       value: |-
-        Please read [about common issues](https://github.com/nRF24/RF24/blob/master/COMMON_ISSUES.md) first.
+        [docs]: https://nRF24.github.io/RF24
+        [api-docs]: https://nrf24.github.io/RF24/classRF24.html
+        [common-issues]: https://github.com/nRF24/RF24/blob/master/COMMON_ISSUES.md
+        [platform-pages]: https://nrf24.github.io/RF24/pages.html
+
+        Please read [about common issues][common-issues] first.
         It addresses the most common problems that people have (whether they know it or not).
 
         > [!caution]
         > These issues/tickets are intended **only for problems related to the RF24 library** source code.
-        > Please use other forums/communities to ask questions that related to your source code.
+        > Please use other forums/communities to ask questions that specific to _your_ source code.
         > - [Arduino Forums](https://forum.arduino.cc/)
         > - [PlatformIO forums](https://community.platformio.org/)
 
-        We also host exhaustive [library documentation](https://nRF24.github.io/RF24).
-        Please check the [API docs](https://nrf24.github.io/RF24/classRF24.html)
-        and/or [platform-specific pages](https://nrf24.github.io/RF24/pages.html)
-        to see if your question is addressed there.
-
-        Python users should migrate to using our [pyRF24](https://github.com/nRF24/pyRF24) python package.
-
-        <details><summary>The pyRF24 package has numerous advantages over the older/individual python wrapper(s)</summary>
-
-        - [x] [drop-in compatible](https://nrf24.github.io/pyRF24/#migrating-to-pyrf24)
-        - [x] available via [`pip install pyrf24`](https://pypi.org/project/pyrf24/)
-        - [x] no need to build from source, and does not require the C++ libraries installed
-        - [x] includes wrappers for RF24, RF24Network, RF24Mesh libraries and a fake BLE implementation
-        - [x] includes typing stubs for type checking tools like mypy
-        - [x] has [dedicated documentation](https://nrf24.github.io/pyRF24) and supports Python's builtin `help()` function
-
-        </details>
+        We also host exhaustive [library documentation][docs].
+        Please check the [API documentation][api-docs] or [platform support pages][platform-pages] to see if your question is addressed there.
+
+        > [!important]
+        > Python users should migrate to using our [pyRF24](https://github.com/nRF24/pyRF24) python package.
+        >
+        > <details><summary>The pyRF24 package has numerous advantages over the older/individual python wrapper(s)</summary>
+        >
+        > - [x] [drop-in compatible](https://nrf24.github.io/pyRF24/#migrating-to-pyrf24) API
+        > - [x] available via [`pip install pyrf24`](https://pypi.org/project/pyrf24/)
+        > - [x] no need to build from source and does not require the C++ libraries installed
+        > - [x] includes wrappers for RF24, RF24Network, RF24Mesh libraries and a fake BLE implementation
+        > - [x] includes typing stubs for type checking tools like mypy
+        > - [x] has [dedicated documentation](https://nrf24.github.io/pyRF24) and supports Python's builtin `help()` function
+        >
+        > </details>
 
   - type: textarea
     id: user-question
     attributes:
       # `label` is a required field here. I'm guessing that it cannot be an empty string.
       label: What would you like to know?
       placeholder: You can use markdown syntax here
-    validation:
+    validations:
       required: true
 
   - type: markdown
     id: how-to-md
     attributes:
       value: |-
+        [gfm-doc]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
+
         GitHub supports their own flavor of MarkDown syntax.
-        Learn more in [GitHub's documentation](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).
+        Learn more about writing Markdown syntax in [GitHub's documentation][gfm-doc].