Open
Conversation
Reviewer's Guide by SourceryThis pull request introduces two new issue templates to the repository: 'bug_report.yml' and 'feature_request.yml'. These templates provide structured forms for users to submit bug reports and feature requests, respectively. Each template defines a set of input fields with specific types, labels, descriptions, and validations to guide users in providing the necessary information. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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?
We needed to improve the issue reporting process by adding dedicated issue templates that help our community provide all necessary details when reporting bugs or suggesting features. This creates consistency in the information submitted, making it easier to diagnose and prioritize issues.
What and how are we changing? Why this approach?
This pull request introduces two new issue templates:
Both templates are designed with clear labels, descriptions, and validations to ensure that key information is collected from the outset. This structured approach will reduce back-and-forth clarifications with users and streamline our troubleshooting and feature enhancement processes.
What actions are required from users?
Users will now see these templates as options when creating new issues:
No additional user configuration is needed on our part.
How does it work? (Technical details)
Is it backwards compatible?
Yes, these changes are fully backwards compatible. They only affect new issue submissions and do not alter any existing functionalities of the repository.
Any other considerations?