summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authormicroDev <70126934+microDev1@users.noreply.github.com>2021-03-04 02:38:46 +0530
committermicroDev <70126934+microDev1@users.noreply.github.com>2021-03-04 02:38:46 +0530
commit9aa11ec51e40b96c317ebca276b3a8ebeb928310 (patch)
treeb5f2db92dfac988b8c75f25d3d80a7d8b0370bde /.github
parent7c2a291bd1e3bbed8422b80f588132aaaaac3c37 (diff)
Apply suggestions from code review
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md30
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml4
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md6
3 files changed, 28 insertions, 12 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 997dc5438..22365d0f4 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -2,39 +2,55 @@
name: Bug report
about: Create a report to help us improve
title: ''
-labels: ''
+labels: 'bug'
assignees: ''
---
-Thanks! for testing out CircuitPython. Now that you have got a problem... you can
-file a bug report for it. Feel free to modify the below format to better suit your issue.
-Also, don't forget to remove me... :)
+<!-- Thanks! for testing out CircuitPython. Now that you have got a problem...
+you can file a bug report for it. Feel free to modify the below format to better
+suit your issue. :) -->
**Firmware**
+<!-- Include the version of CircuitPython you're running. You can see it in the
+`boot_out.txt` file, as well as in the REPL. -->
+
```python
Adafruit CircuitPython 6.2.0-beta.2 on 2021-03-01; Raspberry Pi Pico with rp2040
```
+
**Code/REPL**
+<!-- Include your code that reproduces the bug here. Try to distill down to the
+minimum possible to reproduce. -->
+
```python
import busio, bitbangio
i2c = bitbangio.I2C(board.GP1, board.GP0)
```
+
**Behavior**
+<!-- What happens when you run the code above? Include any error messages. -->
+
```python
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TimeoutError: Clock stretch too long
```
-**Description** _(optional)_
+
+**Description**
+
+<!-- Optionally, describe the issue in more detail. Here are some examples: -->
- Error while using i2c...
- Only happens when...
- might be related to #4291...
-**Additional Info** _(optional)_
+**Additional Info**
+
+<!-- Optionally, add any other information like hardware connection, scope output etc.
+If you have already done some debugging, mention it here. -->
-Any other information like hardware connection, scope output etc.
+Removing [this](url) line resolves the issue.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index 138fa4c1b..73bf24af0 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,7 +1,7 @@
contact_links:
- name: Adafruit Forum
url: https://forums.adafruit.com/
- about: Not sure if a bug is indeed a bug... post it here.
+ about: Official Adafruit technical support forum. Good for getting help on getting a project working.
- name: Adafruit Discord
url: https://adafru.it/discord
- about: Similar to the forum but more exposure and prompt replies.
+ about: Unofficial chat with many helpful folks and normally prompt replies.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index c6a79ffa0..4f65b8414 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -2,10 +2,10 @@
name: Feature request
about: Suggest an idea for this project
title: ''
-labels: ''
+labels: 'enhancement'
assignees: ''
---
-We are always adding new features and enhancements to CircuitPython 🚀
-and would love ❤ to see what new challenge you have got for us... 🙂
+<!-- We are always adding new features and enhancements to CircuitPython 🚀
+and would love ❤ to see what new challenge you have got for us... 🙂 -->