Skip to content

Commit 9aa11ec

Browse files
committed
Apply suggestions from code review
1 parent 7c2a291 commit 9aa11ec

File tree

3 files changed

+28
-12
lines changed

3 files changed

+28
-12
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,55 @@
22
name: Bug report
33
about: Create a report to help us improve
44
title: ''
5-
labels: ''
5+
labels: 'bug'
66
assignees: ''
77

88
---
99

10-
Thanks! for testing out CircuitPython. Now that you have got a problem... you can
11-
file a bug report for it. Feel free to modify the below format to better suit your issue.
12-
Also, don't forget to remove me... :)
10+
<!-- Thanks! for testing out CircuitPython. Now that you have got a problem...
11+
you can file a bug report for it. Feel free to modify the below format to better
12+
suit your issue. :) -->
1313

1414
**Firmware**
1515

16+
<!-- Include the version of CircuitPython you're running. You can see it in the
17+
`boot_out.txt` file, as well as in the REPL. -->
18+
1619
```python
1720
Adafruit CircuitPython 6.2.0-beta.2 on 2021-03-01; Raspberry Pi Pico with rp2040
1821
```
22+
1923
**Code/REPL**
2024

25+
<!-- Include your code that reproduces the bug here. Try to distill down to the
26+
minimum possible to reproduce. -->
27+
2128
```python
2229
import busio, bitbangio
2330
i2c = bitbangio.I2C(board.GP1, board.GP0)
2431
```
32+
2533
**Behavior**
2634

35+
<!-- What happens when you run the code above? Include any error messages. -->
36+
2737
```python
2838
Traceback (most recent call last):
2939
File "<stdin>", line 1, in <module>
3040
TimeoutError: Clock stretch too long
3141
```
32-
**Description** _(optional)_
42+
43+
**Description**
44+
45+
<!-- Optionally, describe the issue in more detail. Here are some examples: -->
3346

3447
- Error while using i2c...
3548
- Only happens when...
3649
- might be related to #4291...
3750

38-
**Additional Info** _(optional)_
51+
**Additional Info**
52+
53+
<!-- Optionally, add any other information like hardware connection, scope output etc.
54+
If you have already done some debugging, mention it here. -->
3955

40-
Any other information like hardware connection, scope output etc.
56+
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:
22
- name: Adafruit Forum
33
url: https://forums.adafruit.com/
4-
about: Not sure if a bug is indeed a bug... post it here.
4+
about: Official Adafruit technical support forum. Good for getting help on getting a project working.
55
- name: Adafruit Discord
66
url: https://adafru.it/discord
7-
about: Similar to the forum but more exposure and prompt replies.
7+
about: Unofficial chat with many helpful folks and normally prompt replies.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
name: Feature request
33
about: Suggest an idea for this project
44
title: ''
5-
labels: ''
5+
labels: 'enhancement'
66
assignees: ''
77

88
---
99

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

0 commit comments

Comments
 (0)