From 1333564f7864b6203e369c3a3af3ec25487c3943 Mon Sep 17 00:00:00 2001 From: MicroDev <70126934+MicroDev1@users.noreply.github.com> Date: Tue, 14 Mar 2023 16:17:13 +0530 Subject: [PATCH] add issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 87 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 7 ++ .github/ISSUE_TEMPLATE/feature_request.md | 11 +++ 3 files changed, 105 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml 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.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..63e35c7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,87 @@ +name: 🐞 Bug Report +description: Create a bug report to help us improve +labels: + - bug +body: + - type: markdown + attributes: + value: >- + Thanks for testing out CircuitPython Code Editor! + 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 on your board. + You can see it in 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: dropdown + id: workflows + attributes: + label: Workflow(s) + description: What workflow(s) are you seeing the problem on? + multiple: true + options: + - BLE + - USB + - WEB + validations: + required: true + - type: textarea + id: browsers + attributes: + label: Browser(s) + description: >- + What browser(s) are you seeing the problem on? + Please also mention the browser's version (if available). + placeholder: | + Google Chrome 111.0.5563.65 + render: python + validations: + required: true + - type: textarea + id: console + attributes: + label: Console Log + description: >- + The browser's console log (if available). + This will be automatically formatted into code, so no need for backticks. + placeholder: | + script.js:400 write failed ReferenceError: encoder is not defined + at oa.writeFile (usb-file-transfer.js:156:13) + at async Nl.writeFile (file.js:67:13) + render: python + validations: + required: false + - type: textarea + id: steps + attributes: + label: Steps + description: Please mention the steps needed to replicate the issue. + placeholder: | + 1. Connect to the board with the USB workflow + 2. Allow access to the drive (not called CIRCUITPY) + 3. Write in a new file print("Hello") + validations: + required: true + - type: textarea + id: description + attributes: + label: Description + description: Optionally, describe the bug in more detail. + placeholder: | + - Error while using... + - Only happens when... + - Might be related to #64... + - type: textarea + id: more-info + attributes: + label: Additional information + description: >- + Optionally, add any other information like screenshot of the page. + 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 new file mode 100644 index 0000000..2990e0d --- /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 0000000..87349ee --- /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: '' + +--- + +