Add GitHub issue templates (Bug Report, Feature Request, Description) #146
Description
Summary
This repository currently has no GitHub issue templates. When a user clicks "New Issue", they are presented with a blank text editor, which leads to inconsistent issue formatting and missing context.
Proposed Change
Add structured issue templates using GitHub's YAML issue forms so that the "New Issue" page presents contributors with 3 template options:
| Template | Purpose |
|---|---|
| Bug Report | Report bugs with structured fields for reproduction steps, expected/actual behavior, affected component, and environment details |
| Feature Request | Propose new features with fields for problem statement, proposed solution, alternatives considered, and affected component |
| Description | General issues, questions, or discussion topics that don't fit the other categories |
A config.yml is also included to disable blank issues, ensuring all issues follow one of the provided templates.
Files Added
- .github/ISSUE_TEMPLATE/bug_report.yml
- .github/ISSUE_TEMPLATE/feature_request.yml
- .github/ISSUE_TEMPLATE/description.yml
- .github/ISSUE_TEMPLATE/config.yml
Benefits
- Consistent issue formatting across the project
- Required fields ensure essential context is always provided
- Component dropdown (Library, Prototype, Data pipeline, Analysis, Docs) helps with triage
- Reduces back-and-forth between maintainers and issue reporters