Skip to content

Commit bae5111

Browse files
2bndy52bndy5
authored
migrate issue templates into forms (#985)
1 parent 81348ad commit bae5111

File tree

7 files changed

+277
-51
lines changed

7 files changed

+277
-51
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
name: Report a problem
2+
description: Create a report to let us help you
3+
body:
4+
5+
# This stuff will be rendered when the user is creating the issue.
6+
# It is not included in the issue's description when the user submits the issue
7+
- type: markdown
8+
attributes:
9+
value: |-
10+
[docs]: https://nRF24.github.io/RF24
11+
[api-docs]: https://nrf24.github.io/RF24/classRF24.html
12+
[common-issues]: https://github.com/nRF24/RF24/blob/master/COMMON_ISSUES.md
13+
[platform-pages]: https://nrf24.github.io/RF24/pages.html
14+
15+
Please read [about common issues][common-issues] first.
16+
It addresses the most common problems that people have (whether they know it or not).
17+
18+
> [!caution]
19+
> These issues/tickets are intended **only for problems related to the RF24 library** source code.
20+
> Please use other forums/communities to ask questions that specific to _your_ source code.
21+
> - [Arduino Forums](https://forum.arduino.cc/)
22+
> - [PlatformIO forums](https://community.platformio.org/)
23+
24+
We also host exhaustive [library documentation][docs].
25+
Please check the [API documentation][api-docs] or [platform support pages][platform-pages] to see if your question is addressed there.
26+
27+
> [!important]
28+
> Python users should migrate to using our [pyRF24](https://github.com/nRF24/pyRF24) python package.
29+
>
30+
> <details><summary>The pyRF24 package has numerous advantages over the older/individual python wrapper(s)</summary>
31+
>
32+
> - [x] [drop-in compatible](https://nrf24.github.io/pyRF24/#migrating-to-pyrf24) API
33+
> - [x] available via [`pip install pyrf24`](https://pypi.org/project/pyrf24/)
34+
> - [x] no need to build from source and does not require the C++ libraries installed
35+
> - [x] includes wrappers for RF24, RF24Network, RF24Mesh libraries and a fake BLE implementation
36+
> - [x] includes typing stubs for type checking tools like mypy
37+
> - [x] has [dedicated documentation](https://nrf24.github.io/pyRF24) and supports Python's builtin `help()` function
38+
>
39+
> </details>
40+
41+
- type: input
42+
id: module
43+
attributes:
44+
label: What radio module do you use?
45+
description: >-
46+
Please tell us what type of radio(s) you are using.
47+
We are especially interested if you are using a PA/LNA variant.
48+
placeholder: nRF24L01+ PA/LNA, nRF24L01+
49+
validations:
50+
required: true
51+
52+
- type: input
53+
id: platform
54+
attributes:
55+
label: What driver board(s) do you use?
56+
description: >-
57+
Please tell us what board(s) you are using to drive the radio.
58+
placeholder: Arduino UNO, RPi3, RPi Pico
59+
validations:
60+
required: true
61+
62+
- type: markdown
63+
attributes:
64+
value: |-
65+
> [!warning]
66+
> Any 64-bit Linux OS requires installing RF24 libraries with
67+
> [our CMake instructions](https://nrf24.github.io/RF24/md_docs_2using__cmake.html).
68+
69+
- type: textarea
70+
id: linux-os
71+
attributes:
72+
label: If using Linux, what OS are you using?
73+
description: |-
74+
This is only needed if you are using a Linux system to drive the radio.
75+
76+
Please copy and paste the output for the following command:
77+
78+
```text
79+
uname -srm && lsb_release -a
80+
```
81+
placeholder: |-
82+
Linux 6.6.28+rpt-rpi-v7 armv7l
83+
No LSB modules are available.
84+
Distributor ID: Raspbian
85+
Description: Raspbian GNU/Linux 12 (bookworm)
86+
Release: 12
87+
Codename: bookworm
88+
render: text
89+
90+
- type: dropdown
91+
id: linux-driver
92+
attributes:
93+
label: If using Linux, what RF24 driver did you select?
94+
description: |-
95+
These are hardware drivers that the RF24 library supports on Linux.
96+
Please select which one you used.
97+
98+
> [!note]
99+
> The `SPIDEV` driver is highly recommended and will be the only driver supported in the future.
100+
> See rationale in [nRF24/RF24#971](https://github.com/nRF24/RF24/issues/971).
101+
options:
102+
- SPIDEV (linux kernel)
103+
- RPi (BCM2835 library)
104+
- MRAA
105+
- wiringPi
106+
- pigpio
107+
- LittleWire
108+
109+
- type: textarea
110+
id: user-issue
111+
attributes:
112+
label: Describe your problem
113+
description: Please use as much detail as possible.
114+
placeholder: You can use markdown syntax here
115+
validations:
116+
required: true
117+
118+
- type: markdown
119+
id: how-to-md
120+
attributes:
121+
value: |-
122+
[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
123+
124+
GitHub supports their own flavor of MarkDown syntax.
125+
Learn more about writing Markdown syntax in [GitHub's documentation][gfm-doc].
126+
127+
- type: textarea
128+
id: rx-code
129+
attributes:
130+
label: What is the RX code?
131+
description: >-
132+
Use this area to show your relevant source code for RX behavior.
133+
value: |-
134+
#include <RF24.h>
135+
// ...
136+
render: cpp
137+
138+
- type: textarea
139+
id: tx-code
140+
attributes:
141+
label: What is the TX code?
142+
description: >-
143+
Use this area to show your relevant source code for TX behavior.
144+
value: |-
145+
// The code for RX is same for TX.
146+
// See above code for RX
147+
render: cpp

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# this setting will force users to use the provided issue templates
2+
blank_issues_enabled: true
3+
# This setting may be changed in the future if the templates are not being used!
4+
5+
# if the templates provided don't fit the subject of the user feedback,
6+
# here we can give links to other forms of user feedback
7+
contact_links:
8+
- name: Arduino Forums
9+
url: https://forum.arduino.cc/
10+
about: A place for questions not specific to RF24 library (for Arduino users)
11+
- name: PlatformIO Forums
12+
url: https://community.platformio.org/
13+
about: A place for questions not specific to RF24 library (for PlatformIO users)
14+
- name: Common nRF24L01 problems
15+
url: https://nrf24.github.io/RF24/md_COMMON__ISSUES.html
16+
about: We have documented common issues for user convenience and quick solutions
17+
- name: RF24 API documentation
18+
url: https://nrf24.github.io/RF24/classRF24.html
19+
about: Our exhaustive documentation helps describe expected behavior
20+
# This link is only useful if blank issues templates are disabled (see top of this file)
21+
# Uncomment this list item and disable blank issue templates
22+
# to allow only maintainers the ability to open a blank issue
23+
# - name: Maintainers' note
24+
# url: https://github.com/nRF24/RF24/issues/new
25+
# about: Start a discussion for maintainers only

‎.github/ISSUE_TEMPLATE/feature-request.yml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
body:
4+
- type: textarea
5+
id: behavior
6+
attributes:
7+
label: Describe the behavior you would like
8+
description: >-
9+
Use this area to describe what behavior you desire.
10+
Please be clear and concise as possible.
11+
placeholder: You can use markdown syntax here
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: proposal
17+
attributes:
18+
label: Propose an implementation or solution
19+
description: >-
20+
How do you imagine this will be implemented in code?
21+
placeholder: You can use markdown syntax here
22+
23+
- type: textarea
24+
id: alternative
25+
attributes:
26+
label: Describe alternatives you have considered
27+
description: >-
28+
Were you able to achieve the desired behavior in some other/inconvenient way?
29+
placeholder: You can use markdown syntax here
30+
31+
- type: textarea
32+
id: added-context
33+
attributes:
34+
label: Additional context
35+
description: >-
36+
If there is anything that might be special or specific to your usage, please let us know.
37+
placeholder: You can use markdown syntax here
38+
39+
- type: markdown
40+
id: how-to-md
41+
attributes:
42+
value: |-
43+
[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
44+
45+
GitHub supports their own flavor of MarkDown syntax.
46+
Learn more about writing Markdown syntax in [GitHub's documentation][gfm-doc].

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/question.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/question.yml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Question
2+
description: Have a question?
3+
title: "[Question]: "
4+
labels: ["question"]
5+
body:
6+
7+
# This stuff will be rendered when the user is creating the issue.
8+
# It is not included in the issue's description when the user submits the issue
9+
- type: markdown
10+
attributes:
11+
value: |-
12+
[docs]: https://nRF24.github.io/RF24
13+
[api-docs]: https://nrf24.github.io/RF24/classRF24.html
14+
[common-issues]: https://github.com/nRF24/RF24/blob/master/COMMON_ISSUES.md
15+
[platform-pages]: https://nrf24.github.io/RF24/pages.html
16+
17+
Please read [about common issues][common-issues] first.
18+
It addresses the most common problems that people have (whether they know it or not).
19+
20+
> [!caution]
21+
> These issues/tickets are intended **only for problems related to the RF24 library** source code.
22+
> Please use other forums/communities to ask questions that specific to _your_ source code.
23+
> - [Arduino Forums](https://forum.arduino.cc/)
24+
> - [PlatformIO forums](https://community.platformio.org/)
25+
26+
We also host exhaustive [library documentation][docs].
27+
Please check the [API documentation][api-docs] or [platform support pages][platform-pages] to see if your question is addressed there.
28+
29+
> [!important]
30+
> Python users should migrate to using our [pyRF24](https://github.com/nRF24/pyRF24) python package.
31+
>
32+
> <details><summary>The pyRF24 package has numerous advantages over the older/individual python wrapper(s)</summary>
33+
>
34+
> - [x] [drop-in compatible](https://nrf24.github.io/pyRF24/#migrating-to-pyrf24) API
35+
> - [x] available via [`pip install pyrf24`](https://pypi.org/project/pyrf24/)
36+
> - [x] no need to build from source and does not require the C++ libraries installed
37+
> - [x] includes wrappers for RF24, RF24Network, RF24Mesh libraries and a fake BLE implementation
38+
> - [x] includes typing stubs for type checking tools like mypy
39+
> - [x] has [dedicated documentation](https://nrf24.github.io/pyRF24) and supports Python's builtin `help()` function
40+
>
41+
> </details>
42+
43+
- type: textarea
44+
id: user-question
45+
attributes:
46+
# `label` is a required field here. I'm guessing that it cannot be an empty string.
47+
label: What would you like to know?
48+
placeholder: You can use markdown syntax here
49+
validations:
50+
required: true
51+
52+
- type: markdown
53+
id: how-to-md
54+
attributes:
55+
value: |-
56+
[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
57+
58+
GitHub supports their own flavor of MarkDown syntax.
59+
Learn more about writing Markdown syntax in [GitHub's documentation][gfm-doc].

0 commit comments

Comments
 (0)