Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 standardize issue reporting and feature requesting, we've added two new issue templates. These templates aim to streamline the issue creation process by ensuring that contributors provide all necessary information in a consistent format. This will improve communication between users and maintainers, ultimately speeding up troubleshooting and development.
What and how are we changing? Why this approach?
We're adding two new YAML files to the .github/ISSUE_TEMPLATE directory:
• bug_report.yml
• feature_request.yml
Each template includes specific fields and placeholders designed to capture essential details about bugs or feature requests. For bug reports, users are prompted to include information such as the bug behavior, logs, screenshots, steps to reproduce, expected behavior, and system details. For feature requests, the template guides users to describe the problem, their current workaround, and what they propose as a solution, among others.
This approach provides clear guidance to our contributors, ensuring that the issues we receive are well-organized and detailed enough to address them efficiently.
What actions are required from users?
Users need to simply follow the provided templates when opening a new issue. When reporting a bug or suggesting a new feature, the corresponding template will appear automatically, guiding them to supply the necessary information for a prompt review.
How does it work? (Technical details)
Is it backwards compatible?
Yes, this change is fully backwards compatible. It adds new files without modifying existing functionality, and the templates will only be used when contributors create new issues.
Any other considerations?