Skip to content

Add issue template - #3452

Merged
csukuangfj merged 1 commit into
k2-fsa:masterfrom
csukuangfj:issue
Apr 1, 2026
Merged

csukuangfj merged 1 commit into
k2-fsa:masterfrom
csukuangfj:issue

Conversation

@csukuangfj

@csukuangfj csukuangfj commented Apr 1, 2026 •

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Documentation
    • Added GitHub issue templates for bug reports and feature requests to standardize issue submissions and help contributors provide comprehensive information.

@dosubot dosubot Bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Apr 1, 2026
@csukuangfj csukuangfj changed the title dd issue template Add issue template Apr 1, 2026
@coderabbitai

coderabbitai Bot commented Apr 1, 2026 •

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 02d92828-1a4d-4a42-947f-53b37c7c0170

📥 Commits

Reviewing files that changed from the base of the PR and between 36a2923 and 9d3d688.

📒 Files selected for processing (2)
  • .github/ISSUE_TEMPLATE/bug_report.md
  • .github/ISSUE_TEMPLATE/feature_request.md

📝 Walkthrough

Walkthrough

Two new GitHub issue templates are added to standardize bug reporting and feature request submissions. Each template includes predefined metadata (labels, title prefixes) and structured forms to guide users in providing relevant information.

Changes

Cohort / File(s) Summary
GitHub Issue Templates
.github/ISSUE_TEMPLATE/bug_report.md, .github/ISSUE_TEMPLATE/feature_request.md
Added standardized templates for bug reports (with bug label and reproduction steps) and feature requests (with enhancement label and motivation sections) to streamline issue submissions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Templates hopping into place so neat,
Bug reports and features, quite the treat!
Structured forms make users smile,
Issues organized, GitHub style! ✨
A rabbit's gift to the dev delight,
Pull requests flowing just right!

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@csukuangfj
csukuangfj merged commit c94cdda into k2-fsa:master Apr 1, 2026
1 check was pending
@csukuangfj
csukuangfj deleted the issue branch April 1, 2026 08:03

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces GitHub issue templates for bug reports and feature requests to standardize issue submissions. The review feedback suggests generalizing the environment section in the bug report template to accommodate the project's multi-language and multi-platform support, as well as adding a markdown placeholder for logs to ensure better formatting and readability.

Comment on lines +36 to +42
### Environment
- `sherpa-onnx` version:
- OS:
- Python version:
- onnxruntime version:
- GPU (if applicable):
- NPU (if applicable):

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The environment section is currently Python-centric. Since sherpa-onnx supports 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.

Suggested change
### Environment
- `sherpa-onnx` version:
- OS:
- Python version:
- onnxruntime version:
- GPU (if applicable):
- NPU (if applicable):
### Environment
- sherpa-onnx version:
- OS & Version (e.g., Ubuntu 22.04, Android 13, macOS 14):
- Programming Language & Version (e.g., Python 3.10, C++ 17, Kotlin 1.9):
- Hardware Architecture (e.g., x86_64, ARM64, Raspberry Pi 4):
- Accelerator & Version (e.g., onnxruntime 1.17.1, CUDA 12.1, RKNN, QNN):

- GPU (if applicable):
- NPU (if applicable):

### Logs

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant