From d99d818bf85090b048baa8efee47383fcaf2bc41 Mon Sep 17 00:00:00 2001 From: microDev <70126934+microDev1@users.noreply.github.com> Date: Wed, 30 Jun 2021 15:42:22 +0530 Subject: [PATCH] update issue form and template --- .github/ISSUE_TEMPLATE/bug_report.yml | 47 ++++++++++++++--------- .github/ISSUE_TEMPLATE/config.yml | 4 +- .github/ISSUE_TEMPLATE/feature_request.md | 4 +- 3 files changed, 32 insertions(+), 23 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 8e3ccf6440..7b6a53dbba 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,49 +1,57 @@ -name: Bug report -description: Report a bug in CircuitPython +name: 🐞 Bug Report +description: Create a bug report to help us improve labels: - bug body: - type: markdown attributes: value: >- - ## Bug Report - Thanks! for testing out CircuitPython. Now that you have got a - problem... you can file a bug report for it. - - type: input + Thanks! for testing out CircuitPython. Now that you have encountered a + bug... you can file a report for it. + - type: textarea id: firmware attributes: label: CircuitPython version description: >- Include the version of CircuitPython you're running. You can see it in - the `boot_out.txt` file, as well as in the REPL. - placeholder: >- - Adafruit CircuitPython 6.2.0-beta.2 on 2021-03-01; Raspberry Pi Pico - with rp2040 + the `boot_out.txt` file, as well as in the `REPL`. + placeholder: Adafruit CircuitPython 6.2.0 on 2021-03-01; Raspberry Pi Pico with rp2040 + render: python + validations: + required: true - type: textarea id: code attributes: label: Code/REPL - placeholder: >- - import busio, bitbangio + description: This is automatically rendered as Python, so no need for backticks. + placeholder: | + import busio, bitbangio i2c = bitbangio.I2C(board.GP1, board.GP0) render: python + validations: + required: true - type: textarea id: behavior attributes: label: Behavior - description: What happens when you run the code above? Include any error messages. - placeholder: >- - Traceback (most recent call last): + description: What happens when you run the code above? Include error messages (if any). + placeholder: | + ```python + Traceback (most recent call last): File "", line 1, in TimeoutError: Clock stretch too long + ``` + On-board led pulses red. + validations: + required: true - type: textarea id: description attributes: label: Description description: Optionally, describe the bug in more detail. - placeholder: >- - - Error while using i2c... - - Only happens when... + placeholder: | + - Error while using i2c... + - Only happens when... - might be related to #4291... - type: textarea id: more-info @@ -51,4 +59,5 @@ body: label: Additional information description: >- Optionally, add any other information like hardware connection, scope - output etc. If you have already done some debugging, mention it here. \ No newline at end of file + output etc. If you have already done some debugging, mention it here. + placeholder: Removing [this](url) line resolves the issue. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 73bf24af0c..2990e0d4b0 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,7 +1,7 @@ contact_links: - - name: Adafruit Forum + - 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 + - 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 index 4f65b84145..87349ee00c 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,5 +1,5 @@ --- -name: Feature request +name: 🚀 Feature Request about: Suggest an idea for this project title: '' labels: 'enhancement' @@ -7,5 +7,5 @@ assignees: '' --- -