Add 2 issue templates #5
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?
To streamline issue reporting and improve clarity in our project management, we are adding two new issue templates: one for bug reports and another for feature requests. This helps ensure consistent, complete, and actionable information is provided when issues or enhancement requests are submitted.
What and how are we changing? Why this approach?
We have added two YAML files under the .github/ISSUE_TEMPLATE directory:
• bug_report.yml – Provides a structured form for users to report bugs, capturing essential details such as bug behavior, logs, and steps to reproduce.
• feature_request.yml – Offers a template for submitting feature requests, guiding users to describe the problem, current workarounds, and proposed solutions.
This approach leverages GitHub’s native support for issue templates, ensuring that every report or request contains the necessary information to help us triage and resolve issues efficiently.
What actions are required from users?
Users do not need to perform any configuration changes. When creating a new issue, GitHub will automatically provide these templates as options. We encourage everyone to use the relevant template to report bugs or request features, ensuring a complete context that will aid in faster issue resolution.
How does it work? (Technical details)
Is it backwards compatible?
Yes, these changes are fully backwards compatible. They are entirely additive and do not interfere with the existing issue reporting workflow. Users still have the option to bypass the templates if they prefer to submit issues directly.
Any other considerations?
Feedback is welcome. As we use these templates, we expect to learn more about the kind of information that is most helpful. Contributions or suggestions to optimize these templates for our project’s needs are appreciated.