docs: improve bug report template #771
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
1 participant
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.
Added a more structured bug report template with fields for title, labels, environment, steps to reproduce, and screenshots/logs to make issues easier to understand, reproduce, and fix.
Description
Added front-matter fields like title, labels, and assignees, plus an Environment and Screenshots/Logs section.
Reordered sections and clarified the helper comments so users provide concise, useful information.
Motivation and Context
To standardize bug reports for easier triage and debugging and to ensure important details (environment, steps, evidence) are not forgotten.
How Has This Been Tested?
Validated that the Markdown structure is syntactically correct and that it matches the usual GitHub issue template format so it can be used directly in a repository