From 4447f9e063bbdf216326c3d81c4bf54aa2940451 Mon Sep 17 00:00:00 2001 From: Albert Ho Date: Tue, 12 Dec 2023 16:28:58 -0800 Subject: [PATCH 1/5] update templates --- .../{bug_report.md => bug_report.yml} | 0 .../{documentation.md => documentation.yml} | 0 .github/ISSUE_TEMPLATE/feature_request.md | 20 ------------------- 3 files changed, 20 deletions(-) rename .github/ISSUE_TEMPLATE/{bug_report.md => bug_report.yml} (100%) rename .github/ISSUE_TEMPLATE/{documentation.md => documentation.yml} (100%) delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.yml similarity index 100% rename from .github/ISSUE_TEMPLATE/bug_report.md rename to .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.yml similarity index 100% rename from .github/ISSUE_TEMPLATE/documentation.md rename to .github/ISSUE_TEMPLATE/documentation.yml diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 51bc9980f..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Porcupine 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. From 4c1a7accbe023199fe59b0d08c25359010f93f6b Mon Sep 17 00:00:00 2001 From: Albert Ho Date: Tue, 12 Dec 2023 16:29:48 -0800 Subject: [PATCH 2/5] add yml --- .github/ISSUE_TEMPLATE/bug_report.yml | 122 +++++++++++++++++++---- .github/ISSUE_TEMPLATE/documentation.yml | 30 +++--- 2 files changed, 120 insertions(+), 32 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 01adeff47..5f80a7255 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,20 +1,104 @@ ---- name: Bug report -about: Bugs in Porcupine -title: 'Porcupine 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.) +description: Bugs in Porcupine +title: "Porcupine Issue: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + **Before** reporting an issue, make sure to read the [documentation](https://picovoice.ai/docs/porcupine/) and search [existing issues](https://github.com/Picovoice/porcupine/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 Porcupine docs + required: true + - label: I have searched the existing issues for Porcupine + required: true + - type: dropdown + id: sdk + attributes: + label: SDK + options: + - Android + - Angular + - .NET + - Flutter + - Go + - iOS + - Java + - Node.js + - Python + - React Native + - React + - Rust + - Unity + - Vue + - Web + validations: + required: true + - type: input + id: package + attributes: + label: "Porcupine 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.yml b/.github/ISSUE_TEMPLATE/documentation.yml index 5c7c3b50e..e51fa2ea5 100644 --- a/.github/ISSUE_TEMPLATE/documentation.yml +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -1,14 +1,18 @@ ---- name: Documentation -about: Issues around documentation of Porcupine -title: Porcupine 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) +description: Issues around documentation of Porcupine +title: "Porcupine 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 From ab8c81a49bdc72e68f884b8dafba0108a0723eb5 Mon Sep 17 00:00:00 2001 From: Albert Ho Date: Wed, 13 Dec 2023 11:50:23 -0800 Subject: [PATCH 3/5] disable link checking for st --- demo/mcu/stm32f407/README.md | 8 ++++---- demo/mcu/stm32f411/README.md | 8 ++++---- demo/mcu/stm32f769/README.md | 4 ++-- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/demo/mcu/stm32f407/README.md b/demo/mcu/stm32f407/README.md index 4f7c3dece..bf835550f 100644 --- a/demo/mcu/stm32f407/README.md +++ b/demo/mcu/stm32f407/README.md @@ -27,12 +27,12 @@ This package contains a demo project for the STM32F407 Discovery kit using Porcu ## Installation For this demo, you need to: - + 1. Download and install [STM32CubeIDE](https://www.st.com/en/development-tools/stm32cubeide.html), which is an all-in-one multi-OS development tool for STM32 microcontrollers. 2. Download [STM32Cube MCU Package for STM32F4 series](https://www.st.com/en/embedded-software/stm32cubef4.html) and extract it somewhere on your computer. - + ## AccessKey Porcupine requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using @@ -63,11 +63,11 @@ Then, to compile and run the demo project on a STM32f407 discovery board, perfor 7. Connect the board to the computer and press `Run` > `Debug` 8. There are two build configurations in this project: Single wake word demo, and Multiple wake words demo; choose one of them in the `Qualifier` window and press `ok` - + > :warning: `printf()` uses the SWO connector and the trace port 0. For more information, refer > to [STM32 microcontroller debug toolbox](https://www.st.com/resource/en/application_note/dm00354244-stm32-microcontroller-debug-toolbox-stmicroelectronics.pdf) > , Chapter 7. - + For single wake-word demos, you can identify the default keyword for each language by referring to the [pv_params.h](./stm32f407g-disc1/Inc/pv_params.h) file. Within this file, locate the language section enclosed by: ```c diff --git a/demo/mcu/stm32f411/README.md b/demo/mcu/stm32f411/README.md index 98538cb49..c33ebae0b 100644 --- a/demo/mcu/stm32f411/README.md +++ b/demo/mcu/stm32f411/README.md @@ -26,12 +26,12 @@ This package contains a demo project for the STM32F411 Discovery kit using Porcu ## Installation For this demo, you need to: - + 1. Download and install [STM32CubeIDE](https://www.st.com/en/development-tools/stm32cubeide.html), which is an all-in-one multi-OS development tool for STM32 microcontrollers. 2. Download [STM32Cube MCU Package for STM32F4 series](https://www.st.com/en/embedded-software/stm32cubef4.html) and extract it somewhere on your computer. - + ## AccessKey Porcupine requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using @@ -62,12 +62,12 @@ Then, to compile and run the demo project on a STM32f411 discovery board, perfor 7. Connect the board to the computer and press `Run` > `Debug` 8. There are two build configurations in this project: Single wake word demo, and Multiple wake words demo; choose one of them in the `Qualifier` window and press `ok` - + > :warning: `printf()` uses the SWO connector and the trace port 0. For more information, refer > to [STM32 microcontroller debug toolbox](https://www.st.com/resource/en/application_note/dm00354244-stm32-microcontroller-debug-toolbox-stmicroelectronics.pdf) > , Chapter 7. - + For single wake-word demos, you can identify the default keyword for each language by referring to the [pv_params.h](./stm32f411e-disco/Inc/pv_params.h) file. Within this file, locate the language section enclosed by: ```c diff --git a/demo/mcu/stm32f769/README.md b/demo/mcu/stm32f769/README.md index 0bbf7e806..fe1a66d13 100644 --- a/demo/mcu/stm32f769/README.md +++ b/demo/mcu/stm32f769/README.md @@ -26,9 +26,9 @@ This package contains a demo project for the STM32F769 Discovery kit using Porcu ## Installation For this demo, you need to: - + 1. Download and install [STM32CubeIDE](https://www.st.com/en/development-tools/stm32cubeide.html), which is an - all-in-one multi-OS development tool for STM32 microcontrollers. + all-in-one multi-OS development tool for STM32 microcontrollers. 2. Install a serial port monitor on your system to be able to communicate with the board. [Arduino environment's built-in serial monitor](https://www.arduino.cc/en/software) and [Coolterm](https://freeware.the-meiers.org/) are two free options available on all platforms (Windows, Linux, and From 7c7d37fda156d04011213db370742e24bd6ba943 Mon Sep 17 00:00:00 2001 From: Albert Ho Date: Wed, 13 Dec 2023 11:51:20 -0800 Subject: [PATCH 4/5] add c --- .github/ISSUE_TEMPLATE/bug_report.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 5f80a7255..ac809dded 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -24,6 +24,7 @@ body: options: - Android - Angular + - C - .NET - Flutter - Go From 810b061f00a934f1aff4f53e7dfa2f8cdce2524a Mon Sep 17 00:00:00 2001 From: Albert Ho Date: Wed, 13 Dec 2023 16:46:35 -0800 Subject: [PATCH 5/5] add MCU --- .github/ISSUE_TEMPLATE/bug_report.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index ac809dded..72998f2fd 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -30,6 +30,7 @@ body: - Go - iOS - Java + - MCU - Node.js - Python - React Native