Skip to content

Commit d99d818

Browse files
authored
update issue form and template
1 parent 89678f7 commit d99d818

File tree

3 files changed

+32
-23
lines changed

3 files changed

+32
-23
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 28 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,63 @@
1-
name: Bug report
2-
description: Report a bug in CircuitPython
1+
name: 🐞 Bug Report
2+
description: Create a bug report to help us improve
33
labels:
44
- bug
55
body:
66
- type: markdown
77
attributes:
88
value: >-
9-
## Bug Report
10-
Thanks! for testing out CircuitPython. Now that you have got a
11-
problem... you can file a bug report for it.
12-
- type: input
9+
Thanks! for testing out CircuitPython. Now that you have encountered a
10+
bug... you can file a report for it.
11+
- type: textarea
1312
id: firmware
1413
attributes:
1514
label: CircuitPython version
1615
description: >-
1716
Include the version of CircuitPython you're running. You can see it in
18-
the `boot_out.txt` file, as well as in the REPL.
19-
placeholder: >-
20-
Adafruit CircuitPython 6.2.0-beta.2 on 2021-03-01; Raspberry Pi Pico
21-
with rp2040
17+
the `boot_out.txt` file, as well as in the `REPL`.
18+
placeholder: Adafruit CircuitPython 6.2.0 on 2021-03-01; Raspberry Pi Pico with rp2040
19+
render: python
20+
validations:
21+
required: true
2222
- type: textarea
2323
id: code
2424
attributes:
2525
label: Code/REPL
26-
placeholder: >-
27-
import busio, bitbangio
26+
description: This is automatically rendered as Python, so no need for backticks.
27+
placeholder: |
28+
import busio, bitbangio
2829
i2c = bitbangio.I2C(board.GP1, board.GP0)
2930
render: python
31+
validations:
32+
required: true
3033
- type: textarea
3134
id: behavior
3235
attributes:
3336
label: Behavior
34-
description: What happens when you run the code above? Include any error messages.
35-
placeholder: >-
36-
Traceback (most recent call last):
37+
description: What happens when you run the code above? Include error messages (if any).
38+
placeholder: |
39+
```python
40+
Traceback (most recent call last):
3741
File "<stdin>", line 1, in <module>
3842
TimeoutError: Clock stretch too long
43+
```
44+
On-board led pulses red.
45+
validations:
46+
required: true
3947
- type: textarea
4048
id: description
4149
attributes:
4250
label: Description
4351
description: Optionally, describe the bug in more detail.
44-
placeholder: >-
45-
- Error while using i2c...
46-
- Only happens when...
52+
placeholder: |
53+
- Error while using i2c...
54+
- Only happens when...
4755
- might be related to #4291...
4856
- type: textarea
4957
id: more-info
5058
attributes:
5159
label: Additional information
5260
description: >-
5361
Optionally, add any other information like hardware connection, scope
54-
output etc. If you have already done some debugging, mention it here.
62+
output etc. If you have already done some debugging, mention it here.
63+
placeholder: Removing [this](url) line resolves the issue.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
contact_links:
2-
- name: Adafruit Forum
2+
- name: 🔗 Adafruit Forum
33
url: https://forums.adafruit.com/
44
about: Official Adafruit technical support forum. Good for getting help on getting a project working.
5-
- name: Adafruit Discord
5+
- name: 🔗 Adafruit Discord
66
url: https://adafru.it/discord
77
about: Unofficial chat with many helpful folks and normally prompt replies.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
name: Feature request
2+
name: 🚀 Feature Request
33
about: Suggest an idea for this project
44
title: ''
55
labels: 'enhancement'
66
assignees: ''
77

88
---
99

10-
<!-- We are always adding new features and enhancements to CircuitPython 🚀
10+
<!-- We keep adding new features and enhancements to CircuitPython 🚀
1111
and would love ❤ to see what new challenge you have got for us... 🙂 -->

0 commit comments

Comments
 (0)