From eafcd7d3646dc887d403c6f0f04452f41b4649b5 Mon Sep 17 00:00:00 2001 From: microDev <70126934+microDev1@users.noreply.github.com> Date: Wed, 3 Mar 2021 11:22:33 +0530 Subject: [PATCH 1/3] add issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 40 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 7 ++++ .github/ISSUE_TEMPLATE/feature_request.md | 11 +++++++ 3 files changed, 58 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..997dc54385 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,40 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +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... :) + +**Firmware** + +```python +Adafruit CircuitPython 6.2.0-beta.2 on 2021-03-01; Raspberry Pi Pico with rp2040 +``` +**Code/REPL** + +```python +import busio, bitbangio +i2c = bitbangio.I2C(board.GP1, board.GP0) +``` +**Behavior** + +```python +Traceback (most recent call last): + File "", line 1, in +TimeoutError: Clock stretch too long +``` +**Description** _(optional)_ + +- Error while using i2c... +- Only happens when... +- might be related to #4291... + +**Additional Info** _(optional)_ + +Any other information like hardware connection, scope output etc. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..138fa4c1b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +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. + - name: Adafruit Discord + url: https://adafru.it/discord + about: Similar to the forum but more exposure and prompt replies. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..c6a79ffa08 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,11 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +We are always adding new features and enhancements to CircuitPython 🚀 +and would love ❤ to see what new challenge you have got for us... 🙂 From 7c2a291bd1e3bbed8422b80f588132aaaaac3c37 Mon Sep 17 00:00:00 2001 From: microDev <70126934+microDev1@users.noreply.github.com> Date: Wed, 3 Mar 2021 21:00:12 +0530 Subject: [PATCH 2/3] add .github to exclusions --- conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/conf.py b/conf.py index 0454ff5ec5..10bd0d9ce0 100644 --- a/conf.py +++ b/conf.py @@ -150,6 +150,7 @@ version = release = final_version # directories to ignore when looking for source files. exclude_patterns = ["**/build*", ".git", + ".github", ".env", ".venv", ".direnv", From 9aa11ec51e40b96c317ebca276b3a8ebeb928310 Mon Sep 17 00:00:00 2001 From: microDev <70126934+microDev1@users.noreply.github.com> Date: Thu, 4 Mar 2021 02:38:46 +0530 Subject: [PATCH 3/3] Apply suggestions from code review --- .github/ISSUE_TEMPLATE/bug_report.md | 30 +++++++++++++++++------ .github/ISSUE_TEMPLATE/config.yml | 4 +-- .github/ISSUE_TEMPLATE/feature_request.md | 6 ++--- 3 files changed, 28 insertions(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 997dc54385..22365d0f41 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... :) + **Firmware** + + ```python Adafruit CircuitPython 6.2.0-beta.2 on 2021-03-01; Raspberry Pi Pico with rp2040 ``` + **Code/REPL** + + ```python import busio, bitbangio i2c = bitbangio.I2C(board.GP1, board.GP0) ``` + **Behavior** + + ```python Traceback (most recent call last): File "", line 1, in TimeoutError: Clock stretch too long ``` -**Description** _(optional)_ + +**Description** + + - Error while using i2c... - Only happens when... - might be related to #4291... -**Additional Info** _(optional)_ +**Additional Info** -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 138fa4c1b0..73bf24af0c 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 c6a79ffa08..4f65b84145 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... 🙂 +