Description
I'd like to request the addition of an issue template file (.github/ISSUE_TEMPLATE.md or .github/ISSUE_TEMPLATE/) to this repository to improve the quality and consistency of issue submissions.
Motivation
Having a standardized issue template would:
- Improve issue quality: Contributors would provide all necessary information upfront
- Save maintainer time: Reduce back-and-forth communication for missing details
- Streamline triage: Make it easier to categorize and prioritize issues
- Guide new contributors: Help first-time contributors understand what information is needed
Suggested Components
An effective issue template could include sections for:
- Issue Type (Bug Report, Feature Request, Documentation, etc.)
- Description of the problem or request
- Steps to Reproduce (for bugs)
- Expected vs. Actual Behavior
- Environment Details (Browser, OS, WebGPU support, WebLLM version, etc.)
- Model Information (which model was being used when the issue occurred)
- Screenshots/Logs (if applicable)
- Additional Context
Example Template Categories
Consider having multiple templates for different issue types:
- Bug Report Template - for runtime issues, errors, crashes
- Feature Request Template - for new functionality suggestions
- Model Support Request - for requesting support for new models
- Documentation Improvement - for docs updates and clarifications
References
GitHub's official documentation on issue templates:
Additional Notes
This would complement any existing contribution guidelines and further enhance the contribution experience for the WebLLM Chat community. Given the technical nature of WebGPU and browser-based LLMs, having structured templates would be particularly valuable for collecting environment-specific information.
Thank you for considering this improvement!
Description
I'd like to request the addition of an issue template file (
.github/ISSUE_TEMPLATE.mdor.github/ISSUE_TEMPLATE/) to this repository to improve the quality and consistency of issue submissions.Motivation
Having a standardized issue template would:
Suggested Components
An effective issue template could include sections for:
Example Template Categories
Consider having multiple templates for different issue types:
References
GitHub's official documentation on issue templates:
Additional Notes
This would complement any existing contribution guidelines and further enhance the contribution experience for the WebLLM Chat community. Given the technical nature of WebGPU and browser-based LLMs, having structured templates would be particularly valuable for collecting environment-specific information.
Thank you for considering this improvement!