Add structured issue templates for bugs, enhancements, and documentation (#2571)

## Motivation for the change, related issues This pull request introduces a set of structured, YAML-based issue templates to improve the quality and consistency of issue reporting in the repository. By guiding contributors to provide specific and relevant information, these templates will help maintainers triage, understand, and resolve issues more efficiently. This new system replaces the free-form issue creation process with three dedicated workflows: 1. **Bug Report:** For reporting reproducible software defects. 2. **Enhancement Request:** For proposing new features or improvements to existing functionality. 3. **Documentation Improvement:** For suggesting corrections, updates, or additions to the project's documentation. ### **Changes Included** This PR adds the following three new files to the `.github/ISSUE_TEMPLATE/` directory: 1. **`1-bug-report.yml`** * Creates a detailed form for submitting bug reports. * Includes fields for prerequisites, a bug summary, expected vs. actual behavior, steps to reproduce, and problem isolation checklists. * Automatically applies the `[Type] Bug` label to new issues. 2. **`2-enhancement.yml`** * Provides a template for feature and enhancement requests. * Prompts the user to describe the desired solution, considered alternatives, and any additional context. * Automatically applies the `[Type] Enhancement` label to new issues. 3. **`3-documentation-improvement.yml`** * Offers a structured way to suggest documentation changes. * Includes fields for describing the request, the reason for it, links to relevant pages, and potential content. * Automatically applies the `[Type] Documentation` label and adds a `cc @fellyph` to the issue body for notification.

Author: fellyph

.github/ISSUE_TEMPLATE/1-bug-report.yml

@@ -0,0 +1,79 @@
+name: 🐞 Bug Report
+description: Report a bug if something isn't working as expected in WordPress Playground.
+labels: ['[Type] Bug']
+body:
+ - type: markdown
+ attributes:
+ value: |
+ ### Thanks for contributing!
+
+ Please provide us with the information requested in this bug report. 
+ Without these details, we won't be able to fully evaluate this issue. 
+ Bug reports lacking detail, or for any other reason than to report a bug, may be closed without action.
+
+ While our goal is to address all the issues reported in this repository, GitHub should be treated as a place to report confirmed bugs only.
+
+ Make sure to look through the [existing `type: bug` issues](https://github.com/WordPress/wordpress-playground/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22%5BType%5D%20Bug%22) to see whether your bug has already been submitted.
+ Feel free to contribute to any existing issues.
+ Search tip: You can filter our issues using [our labels](https://github.com/WordPress/wordpress-playground/labels).
+ Search tip: Make use of [GitHub's search syntax to refine your search](https://help.github.com/en/github/searching-for-information-on-github/searching-issues-and-pull-requests).
+ - type: checkboxes
+ id: prerequisites
+ attributes:
+ label: Prerequisites
+ description: Please confirm these before submitting the issue.
+ options:
+ - label: I have carried out troubleshooting steps and I believe I have found a bug.
+ - label: I have searched for similar bugs in both open and closed issues and cannot find a duplicate.
+ validations:
+ required: true
+ - type: textarea
+ id: summary
+ attributes:
+ label: Describe the bug
+ description: A clear and concise description of what the bug is.
+ validations:
+ required: true
+ - type: textarea
+ id: expected
+ attributes:
+ label: Expected behavior
+ placeholder: |
+ A clear and concise description of what you expected to happen.
+ validations:
+ required: true
+ - type: textarea
+ id: actual
+ attributes:
+ label: Actual behavior
+ placeholder: |
+ A clear and concise description of what actually happens. Please be as descriptive as possible;
+ validations:
+ required: true
+ - type: textarea
+ id: steps
+ attributes:
+ label: Steps to reproduce
+ description: Attach screenshot(s) or recording(s) directly by dragging & dropping.
+ placeholder: |
+ 1. Go to
+ 2. Click on
+ 3. Scroll down to
+ 4. See error
+ validations:
+ required: true
+ - type: checkboxes
+ id: isolating
+ attributes:
+ label: Isolating the problem
+ description: |
+ Please try testing your site for theme and plugin conflicts. 
+ To do that, deactivate all other plugins and switch to a default WordPress theme. Then test again. 
+ If the issue is resolved with the default theme and all other plugins deactivated, it means that one of your other plugins or the theme is causing the issue. 
+ You will then need to enable them one by one and test each time to figure out which plugin or theme is causing the issue.
+ options:
+ - label: I have deactivated other plugins and confirmed this bug occurs when only this plugin is active.
+ - label: This bug happens with a default WordPress theme active.
+ - label: I can reproduce this bug consistently using the steps above.
+ validations:
+ required: true

.github/ISSUE_TEMPLATE/2-enhancement.yml

@@ -0,0 +1,33 @@
+name: ✨ Enhancement Request
+description: If you have an idea to improve existing functionality please let us know or submit a Pull Request!
+title: '[Enhancement]: '
+labels: ['[Type] Enhancement']
+body:
+ - type: markdown
+ attributes:
+ value: |
+ ### Thanks for contributing!
+
+ Please provide us with the information requested in this form. 
+
+ Make sure to look through [existing `type: enhancement` issues](https://github.com/WordPress/wordpress-playground/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22%5BType%5D%20Enhancement%22) to see whether your idea is already being discussed.
+ Feel free to contribute to any existing issues.
+ Search tip: You can filter our issues using [our enhancement label](https://github.com/WordPress/wordpress-playground/issues?q=is%3Aissue+label%3A%22type%3A+enhancement%22+).
+ Search tip: Make use of [GitHub's search syntax to refine your search](https://help.github.com/en/github/searching-for-information-on-github/searching-issues-and-pull-requests).
+ - type: textarea
+ id: summary
+ attributes:
+ label: Describe the solution you'd like
+ description: A clear and concise description of what you want to happen.
+ validations:
+ required: true
+ - type: textarea
+ id: alternative
+ attributes:
+ label: Describe alternatives you've considered
+ description: A clear and concise description of any alternative solutions or features you've considered.
+ - type: textarea
+ id: context
+ attributes:
+ label: Additional context
+ description: Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/3-documentation-improvement.yml

@@ -0,0 +1,48 @@
+name: 📝 Suggestion for Documentation Improvement/Correction
+description: Propose a specific improvement or correction for an existing document.
+title: '[Documentation]: '
+labels: ['[Type] Documentation']
+body:
+ - type: textarea
+ id: description
+ attributes:
+ label: Description of the Request
+ description: |
+ Clearly describe your request.
+
+ If suggesting an improvement or correction: Explain the changes you suggest to improve or correct the existing documentation. Be specific about any errors or areas of confusion you've identified.
+
+ If requesting new documentation: Provide a detailed description of the topic you'd like to see documented.
+ placeholder: 'Describe your suggestion or request in detail.'
+
+ - type: textarea
+ id: reason
+ attributes:
+ label: Reason for the Request
+ description: Explain why this change or new document is important. Why do you believe it will make the documentation clearer, more accurate, or benefit the community?
+ placeholder: 'Explain the importance of this request.'
+
+ - type: input
+ id: page_link
+ attributes:
+ label: Link to the Page/Section (if applicable)
+ description: Provide a link to the specific page or section that you're referring to, or indicate if this is a request for new documentation.
+ placeholder: 'https://wordpress.github.io/wordpress-playground/...'
+
+ - type: textarea
+ id: potential_content
+ attributes:
+ label: Potential Content
+ description: If you have ideas about what the documentation should cover, list the points or sub-topics here.
+ placeholder: 'List potential topics or points to cover.'
+
+ - type: textarea
+ id: additional_context
+ attributes:
+ label: Additional Context
+ description: Add any other context, references, or screenshots that support your suggestion or can help in the creation of new documentation.
+ placeholder: 'Add any extra context or references here.'
+ - type: markdown
+ attributes:
+ value: |
+ cc @fellyph

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+ - name: Playground Slack Channel
+ url: https://wordpress.slack.com/archives/C04EWKGDJ0K
+ about: If you have a question, please see our docs or use our Slack community!