Convert bug report template from Markdown to YAML format #3891
+107
−40
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
- Replace bug_report.md with bug_report.yml - Add structured form fields with validation - Include dropdown for OS selection - Add required field validation for critical information - Improve user experience with guided form fields
There was a problem hiding this comment.
Pull Request Overview
Modernizes the bug report template by replacing the deprecated Markdown file with a structured YAML issue form, improving UX and validation.
- Added
bug_report.ymlas a GitHub issue form with required fields and validation - Removed the old
bug_report.mdfree-form template
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| .github/ISSUE_TEMPLATE/bug_report.yml | New structured YAML issue form (fields, validations) |
| .github/ISSUE_TEMPLATE/bug_report.md | Removed deprecated Markdown template |
Comments suppressed due to low confidence (2)
.github/ISSUE_TEMPLATE/bug_report.yml:2
- [nitpick] The comma before 'below' is unnecessary and can be removed for clarity:
...link below.
description: If you have issues with GitHub Actions, please follow the "support for GitHub Actions" link, below.
.github/ISSUE_TEMPLATE/bug_report.yml:106
- Checkbox inputs require validation under a
validationsblock, not per option. Moverequired: trueout of theoptionsentry and add avalidations: { required: true }section for the checkboxes field.
- label: I agree to follow this project's Code of Conduct
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.
Summary
Modernizes the bug report issue template by converting it from the deprecated Markdown format to the new GitHub YAML format for issue forms.
Changes Made
bug_report.ymlwith structured form fieldsbug_report.mdtemplateKey Improvements
Form Fields Included
Testing
This change will significantly improve the quality and consistency of bug reports submitted to the repository while providing a much better experience for contributors.