Update GitHub bug template #4321
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
daledupreez
added
the
type: task
There was a problem hiding this comment.
Pull Request Overview
This PR refines the GitHub bug report template by introducing clear markdown section headings and inline HTML comments to guide reporters without altering the rendered output.
- Converts plain-text prompts into structured headings and comments for Description, Steps to reproduce, Expected behavior, Screenshots, Environment, and Additional context
- Expands browser examples in the Environment section
- Standardizes use of HTML comments to keep guidance hidden in the final issue
Comments suppressed due to low confidence (2)
.github/ISSUE_TEMPLATE/bug_report.md:35
- [nitpick] Indentation for environment list items is inconsistent; consider using a uniform list style (e.g., no leading spaces before each
-) to improve readability.
- WordPress Version
.github/ISSUE_TEMPLATE/bug_report.md:18
- [nitpick] This label duplicates the ### Steps to reproduce heading; you can remove it to avoid redundancy and streamline the section.
Steps to reproduce the behavior:
annemirasol
approved these changes
May 16, 2025
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.
Changes proposed in this Pull Request:
I files some bug reports this morning, and I realised that our bug template is not great, as it's not taking advantage of options that are available, including comments that won't be in the visible layout (i.e.
<!-- comment -->) and header sections that make sense in the final report.This PR proposes some updates to our bug template in GitHub to make it clearer what we are asking, and what will be in the final report.
Testing instructions
Inspection should be sufficient.
Changelog entry
Changelog Entry Comment
Comment
This PR only affects our GitHub bug reporting template. It does not touch our the code or have any impact on users or usage, unless they happen to file a bug report.
Post merge