Add 2 issue templates #1
Open
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.
Why is this feature needed?
The community relies on well-defined issue templates to report bugs and suggest new features. Adding a bug report and feature request template standardizes the issue reporting process. This consistency helps maintainers quickly gather the required information, identify problems, and understand proposed improvements.
What and how are we changing? Why this approach?
This pull request introduces two new issue templates located in the .github/ISSUE_TEMPLATE directory:
Using YAML for templates ensures simplicity and easy maintenance. The templates include placeholder text and validations to guide users in providing all necessary information, which ultimately improves the quality and clarity of contributions.
What actions are required from users?
Users reporting bugs or requesting features should:
There is no need for any manual configuration from contributors; they only need to select and use the appropriate template when creating an issue.
How does it work? (Technical details)
Is it backwards compatible?
Yes, adding these templates is fully backwards compatible. They will simply be available for issue creation on GitHub without affecting existing issues or workflows.
Any other considerations?