Description
Right now, when contributors open new issues or pull requests, there’s no clear structure to follow. Some people add lots of detail, others add almost nothing. It’d be good to have consistent templates so that bug reports, feature requests, and pull requests are easier to understand and review.
Adding proper GitHub templates will help standardize contributions and save time during triage and review.
Proposed Implementation
-
Create a .github/ISSUE_TEMPLATE directory.
-
Add templates for:
- Bug report (with sections for description, steps to reproduce, expected behavior, etc.)
- Feature request (with sections for motivation, proposed solution, and alternatives)
-
Add a PULL_REQUEST_TEMPLATE.md at the root or under .github/ with fields for summary, related issues, and checklists.
-
Optionally include a config.yml file to disable blank issues and point users toward the right template.
Example Structure
.github/
ISSUE_TEMPLATE/
bug_report.md
feature_request.md
config.yml
PULL_REQUEST_TEMPLATE.md
Example: bug_report.md
---
name: Bug report
about: Report a bug or unexpected behavior
labels: bug
---
### Description
A clear and concise description of the issue.
### Steps to Reproduce
1. Go to '...'
2. Click on '...'
3. See error
### Expected Behavior
What you expected to happen.
### Screenshots or Logs
If applicable, add screenshots or console output.
### Environment
- OS:
- Version:
- Node version:
Example: feature_request.md
---
name: Feature request
about: Suggest a new idea or improvement
labels: enhancement
---
### Motivation
Why is this feature needed?
### Proposed Solution
How do you imagine it working?
### Alternatives
Any other approaches you've considered?
### Additional Context
Any other relevant info or references.
Example: PULL_REQUEST_TEMPLATE.md
### Summary
Brief description of what this PR does.
### Related Issues
Closes #issue-number
### Changes
-
### Checklist
- [ ] Code follows the project’s style guidelines
- [ ] Linting and tests pass
- [ ] Documentation updated (if needed)
Expected Result
- All contributors use the same structure when reporting bugs or proposing features.
- PRs include clear summaries and checklists.
- Easier triage and review for maintainers.
Additional Notes
I'd like to work on adding these templates.
Description
Right now, when contributors open new issues or pull requests, there’s no clear structure to follow. Some people add lots of detail, others add almost nothing. It’d be good to have consistent templates so that bug reports, feature requests, and pull requests are easier to understand and review.
Adding proper GitHub templates will help standardize contributions and save time during triage and review.
Proposed Implementation
Create a
.github/ISSUE_TEMPLATEdirectory.Add templates for:
Add a
PULL_REQUEST_TEMPLATE.mdat the root or under.github/with fields for summary, related issues, and checklists.Optionally include a
config.ymlfile to disable blank issues and point users toward the right template.Example Structure
Example:
bug_report.mdExample:
feature_request.mdExample:
PULL_REQUEST_TEMPLATE.mdExpected Result
Additional Notes
I'd like to work on adding these templates.