Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update issue templates #51

Merged
merged 1 commit into from
Dec 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

93 changes: 93 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -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
14 changes: 0 additions & 14 deletions .github/ISSUE_TEMPLATE/documentation.md

This file was deleted.

18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -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
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.