Open
Conversation
Reviewer's Guide by SourceryThis pull request introduces two new issue templates to the repository: one for bug reports and another for feature requests. These templates provide a structured format for users to submit issues, ensuring that all necessary information is included. The templates are written in YAML format and include fields for describing the issue, steps to reproduce, expected behavior, and other relevant details. 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?
Adding standardized issue templates helps improve issue quality by guiding users to provide all the necessary information when reporting bugs or suggesting new features. This makes it easier for maintainers to triage, reproduce, and address reported issues efficiently, while also ensuring that contributors know exactly what information to provide.
What and how are we changing? Why this approach?
• Two new issue templates have been added to the repository:
By using structured YAML files for these templates, GitHub’s new issue creation interface can automatically prompt users to supply complete information. This approach minimizes the back-and-forth communication needed to gather details during issue triaging.
What actions are required from users?
• No immediate action is required from current contributors.
• When creating a new issue, users will see an option to choose between the bug report and feature request templates, ensuring they provide the necessary details from the start.
• Users are encouraged to update their issue submissions with as much detail as possible to help maintainers address problems quickly.
How does it work? (Technical details)
• The two YAML files under the .github/ISSUE_TEMPLATE directory define the structure and required fields for each issue type.
• Each template specifies field labels, descriptions, placeholders, and validations to ensure the submitted information is both complete and relevant.
• When a user clicks on “New Issue” in GitHub, these templates will be detected and offered as options, letting the user pick the appropriate template based on their needs.
Is it backwards compatible?
Yes, these changes only add new issue templates and do not affect any existing functionality or issues. Users who choose not to use a template will still be able to create issues as before.
Any other considerations?
• Future improvements may include revising fields or adding more templates based on user feedback.
• Maintainers should periodically review the submitted issues to ensure the templates continue to meet the team’s needs.
• With clear guidelines now in place, the overall quality of issue tracking is expected to improve, leading to more efficient debugging and feature implementation processes.