From 268e7977df9fec6391500b8f98268c11512ddfc8 Mon Sep 17 00:00:00 2001 From: Albert Ho Date: Tue, 12 Dec 2023 17:05:45 -0800 Subject: [PATCH] update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 20 ----- .github/ISSUE_TEMPLATE/bug_report.yml | 93 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/documentation.md | 14 ---- .github/ISSUE_TEMPLATE/documentation.yml | 18 +++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ----- 5 files changed, 111 insertions(+), 54 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 37723cb..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Bug report -about: Bugs in Koala -title: 'Koala Issue: ' -labels: bug -assignees: '' - ---- - -Make sure you have read the documentation, and have put forth a reasonable effort to find an existing answer. - -### Expected behaviour - - -### Actual behaviour - - -### Steps to reproduce the behaviour - -(Include enough details so that the issue can be reproduced independently.) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..0bc99e2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,93 @@ +name: Bug report +description: Bugs in Koala +title: "Koala Issue: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + **Before** reporting an issue, make sure to read the [documentation](https://picovoice.ai/docs/koala/) and search [existing issues](https://github.com/Picovoice/koala/issues). + - type: checkboxes + id: check + attributes: + label: Have you checked the docs and existing issues? + description: Make sure you have checked all of the below before submitting an issue + options: + - label: I have read all of the relevant Picovoice Koala docs + required: true + - label: I have searched the existing issues for Koala + required: true + - type: dropdown + id: sdk + attributes: + label: SDK + options: + - Android + - iOS + - Python + - Web + validations: + required: true + - type: input + id: package + attributes: + label: "Koala package version" + placeholder: "1.0.0" + validations: + required: true + - type: input + id: framework + attributes: + label: "Framework version" + placeholder: "Python 3.7, .NET Core 3.1, etc." + validations: + required: true + - type: dropdown + id: platform + attributes: + label: Platform + options: + - Android + - iOS + - Web (WASM) + - Linux (x86_64) + - macOS (x86_64, arm64) + - Windows (x86_64) + - Raspberry Pi + - NVIDIA Jetson + - BeagleBone + - ARM Cortex-M + validations: + required: true + - type: input + id: os + attributes: + label: "OS/Browser version" + placeholder: "macOS 11.0, Android 8.0, etc." + validations: + required: true + - type: textarea + id: description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. + 2. + 3. + validations: + required: true + - type: textarea + id: expectation + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md deleted file mode 100644 index 6ae55a6..0000000 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: Documentation -about: Issues around documentation of Koala -title: Koala Documentation Issue -labels: documentation -assignees: '' - ---- - -### What is the URL of the doc? - - - -### What's the nature of the issue? (e.g. steps do not work, typos/grammar/spelling, etc., out of date) diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 0000000..a33520f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,18 @@ +name: Documentation +description: Issues around documentation of Koala +title: "Koala Documentation Issue: " +labels: ["documentation"] +body: + - type: input + id: url + attributes: + label: What is the URL of the doc? + validations: + required: true + - type: textarea + id: issue + attributes: + label: What is the nature of the issue? + description: e.g. steps do not work, typos/grammar/spelling, out of date, etc. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 035bc6d..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Koala suggestion -title: '' -labels: enhancement -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here.