diff options
| author | Scott Shawcroft <scott@adafruit.com> | 2021-03-04 10:16:09 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-03-04 10:16:09 -0800 |
| commit | 7970c882a658da804ae897ae481ba05c6a59bcba (patch) | |
| tree | 536fda10b481cee063439935e6b9898d509c2693 /.github | |
| parent | 3698d4bc5d7adcdbac3fa745c2b4bfdca8fe0a64 (diff) | |
| parent | 9aa11ec51e40b96c317ebca276b3a8ebeb928310 (diff) | |
Merge pull request #4316 from microDev1/issue-template
Add issue templates
Diffstat (limited to '.github')
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 56 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/config.yml | 7 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 11 |
3 files changed, 74 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..22365d0f4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,56 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +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. :) --> + +**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** + +<!-- 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** + +<!-- Optionally, add any other information like hardware connection, scope output etc. +If you have already done some debugging, mention it here. --> + +Removing [this](url) line resolves the issue. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..73bf24af0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,7 @@ +contact_links: + - name: Adafruit Forum + url: https://forums.adafruit.com/ + about: Official Adafruit technical support forum. Good for getting help on getting a project working. + - name: Adafruit Discord + url: https://adafru.it/discord + 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 new file mode 100644 index 000000000..4f65b8414 --- /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: '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... 🙂 --> |
