Add issue template #3452
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| --- | ||
| name: Bug Report / Issue | ||
| about: Report a reproducible bug or issue with sherpa-onnx | ||
| title: "[BUG] " | ||
| labels: bug | ||
| assignees: "" | ||
| --- | ||
|
|
||
| ### Important Instructions ⚠️ | ||
|
|
||
| Before submitting this issue, please **read carefully** and confirm the following: | ||
|
|
||
| - [ ] I am using the **latest version** of `sherpa-onnx`. If not, I will upgrade and check if the issue persists. | ||
| - [ ] I understand that **issues not reproducible on the latest version** may be closed without response. | ||
| - [ ] I have verified that the error is reproducible using **only `sherpa-onnx`**, not code from my own project. | ||
| - [ ] I will provide **detailed steps** to reproduce the issue. | ||
| - [ ] I will provide **complete logs** and error messages. | ||
| - [ ] I understand that **issues not following these instructions** may be closed or receive no response. | ||
|
|
||
| --- | ||
|
|
||
| ### Describe the issue | ||
|
|
||
| A clear and concise description of the problem. | ||
|
|
||
| ### Steps to reproduce | ||
|
|
||
| 1. Step one | ||
| 2. Step two | ||
| 3. Step three | ||
|
|
||
| ### Expected behavior | ||
|
|
||
| What you expected to happen. | ||
|
|
||
| ### Environment | ||
| - `sherpa-onnx` version: | ||
| - OS: | ||
| - Python version: | ||
| - onnxruntime version: | ||
| - GPU (if applicable): | ||
| - NPU (if applicable): | ||
|
|
||
| ### Logs | ||
|
There was a problem hiding this comment. It is highly recommended to provide a placeholder for logs to ensure they are formatted correctly. You should encourage users to wrap their logs in a markdown code block (using triple backticks) to maintain readability and prevent long logs from cluttering the issue description. |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| --- | ||
| name: Feature Request | ||
| about: Suggest a new feature or improvement for sherpa-onnx | ||
| title: "[FEATURE] " | ||
| labels: enhancement | ||
| assignees: "" | ||
| --- | ||
|
|
||
| ### Describe the feature | ||
|
|
||
| A clear description of the new feature. | ||
|
|
||
| ### Motivation / Use Case | ||
|
|
||
| Why is this feature needed? Who will benefit? | ||
|
|
||
| ### Additional context | ||
|
|
||
| Any context, examples, or references that help understand the feature. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The environment section is currently Python-centric. Since
sherpa-onnxsupports a wide range of programming languages (C++, Java, Swift, Rust, etc.) and platforms (Android, iOS, WebAssembly), it is better to use more generic fields that apply to all users while still allowing for specific details like Python or onnxruntime versions where relevant.