Skip to content

Commit 7970c88

Browse files
authored
Merge pull request #4316 from microDev1/issue-template
Add issue templates
2 parents 3698d4b + 9aa11ec commit 7970c88

File tree

4 files changed

+75
-0
lines changed

4 files changed

+75
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
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. :) -->
13+
14+
**Firmware**
15+
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+
19+
```python
20+
Adafruit CircuitPython 6.2.0-beta.2 on 2021-03-01; Raspberry Pi Pico with rp2040
21+
```
22+
23+
**Code/REPL**
24+
25+
<!-- Include your code that reproduces the bug here. Try to distill down to the
26+
minimum possible to reproduce. -->
27+
28+
```python
29+
import busio, bitbangio
30+
i2c = bitbangio.I2C(board.GP1, board.GP0)
31+
```
32+
33+
**Behavior**
34+
35+
<!-- What happens when you run the code above? Include any error messages. -->
36+
37+
```python
38+
Traceback (most recent call last):
39+
File "<stdin>", line 1, in <module>
40+
TimeoutError: Clock stretch too long
41+
```
42+
43+
**Description**
44+
45+
<!-- Optionally, describe the issue in more detail. Here are some examples: -->
46+
47+
- Error while using i2c...
48+
- Only happens when...
49+
- might be related to #4291...
50+
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. -->
55+
56+
Removing [this](url) line resolves the issue.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
contact_links:
2+
- name: Adafruit Forum
3+
url: https://forums.adafruit.com/
4+
about: Official Adafruit technical support forum. Good for getting help on getting a project working.
5+
- name: Adafruit Discord
6+
url: https://adafru.it/discord
7+
about: Unofficial chat with many helpful folks and normally prompt replies.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
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... 🙂 -->

conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,7 @@
150150
# directories to ignore when looking for source files.
151151
exclude_patterns = ["**/build*",
152152
".git",
153+
".github",
153154
".env",
154155
".venv",
155156
".direnv",

0 commit comments

Comments
 (0)