Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bug Template: Improve structure and guidance for issue reporting #233506

Closed
wants to merge 1 commit into from

Conversation

rik3k
Copy link

@rik3k rik3k commented Nov 10, 2024

Overview

This PR improves the bug report template to help users provide more complete and structured information when reporting issues.

Changes

  • Reorganized template with clear section headers
  • Added dedicated sections for environment details and extension checks
  • Separated expected and actual behavior sections
  • Added specific guidance for different types of bugs (UI, console errors, code issues)
  • Improved instructions for providing system information
  • Added section for reproducible demos

Benefits

  • Reduces back-and-forth communication in issue discussions
  • Makes it easier for maintainers to triage issues
  • Helps users provide necessary information upfront
  • Improves the quality of bug reports

Testing

The template has been tested by:

  • Verifying markdown formatting renders correctly
  • Ensuring all comment blocks are properly formatted
  • Checking that section headers are consistent
  • Validating that guidance text is clear and actionable

Screenshots

Before After
[Previous template layout] [New template layout]

Related Documentation

- Reorganize template with clear section headers
- Add dedicated sections for expected/actual behavior
- Include guidance for extension-related issues
- Add specific instructions for different types of bugs
- Improve documentation for system information
- Add section for reproducible demos

The improved template will help users provide more complete bug reports
upfront, reducing back-and-forth in issue discussions and making it
easier for maintainers to triage and fix issues efficiently.
@Adam877773
Copy link

Adam877773 commented Nov 10, 2024 via email

@rik3k rik3k marked this pull request as ready for review November 10, 2024 00:54
@rik3k rik3k closed this Nov 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants