Repository navigation
Add guide for testing Gutenberg tickets with Playground #156
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
Merged
huzaifaalmesbah
merged 8 commits into
WordPress:trunk
from
khushdoms:add-playground-testing-guide
May 5, 2026
Merged
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
828e059
Add guide for testing Gutenberg tickets with Playground
khushdoms 11c7ba7
Add guide for testing Gutenberg tickets with Playground
khushdoms 9b216db
Update guide with Example testing Gutenberg tickets with Playground
khushdoms d6b16a6
Add route entry for Gutenberg Playground guide
khushdoms 67fca69
Update guide with Example testing Gutenberg tickets with Playground
khushdoms ac8230f
Move guide to correct directory
khushdoms 0b043a1
Update get-setup-for-testing/test-gutenberg-with-playground.md
khushdoms 62f00da
Merge branch 'trunk' into add-playground-testing-guide
khushdoms File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| # Testing Gutenberg Tickets with WordPress Playground | ||
|
|
||
| This guide focuses on the ticket testing workflow for Gutenberg changes using WordPress Playground. The goal is to help contributors reproduce issues, verify fixes, and report results in a consistent format. | ||
|
|
||
| ## When to use Playground | ||
|
|
||
| Use Playground when a Gutenberg ticket can be tested in a browser-only WordPress environment. | ||
|
|
||
| Use a full local environment when testing depends on: | ||
|
|
||
| - Build tooling or custom scripts | ||
| - Complex server configuration | ||
| - Integration with external services | ||
| - Performance or browser automation testing | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before testing, collect the following from the ticket or PR: | ||
|
|
||
| - Ticket/issue URL | ||
| - PR or patch URL (if a fix exists) | ||
| - Exact reproduction steps | ||
| - Expected behavior | ||
| - Any required preconditions (theme, post type, specific block settings, user role) | ||
|
|
||
| Then open Playground: https://playground.wordpress.net/ | ||
|
|
||
| ## Test workflow | ||
|
|
||
| ### 1) Prepare a clean test environment | ||
|
|
||
| 1. Open WordPress Playground in a new browser tab. | ||
| 2. Install and activate the Gutenberg plugin from Plugins > Add New. | ||
| 3. Confirm plugin and WordPress versions if the ticket depends on specific versions. | ||
| 4. Configure any required preconditions from the ticket (for example: specific theme, block settings, or content state). | ||
|
|
||
| ### 2) Reproduce the issue on baseline | ||
|
|
||
| 1. Follow the ticket steps exactly before applying any fix. | ||
| 2. Record what happens (actual behavior) and what should happen (expected behavior). | ||
| 3. If you cannot reproduce, note where behavior diverges from the ticket steps. | ||
|
|
||
| ### 3) Apply and test the proposed fix | ||
|
|
||
| 1. Apply the PR/patch in the best available way for Playground. | ||
|
khushdoms marked this conversation as resolved.
Outdated
|
||
| 2. Repeat the same reproduction steps. | ||
| 3. Confirm whether the expected behavior now occurs. | ||
|
|
||
| ### 4) Run targeted regression checks | ||
|
|
||
| Check nearby editor behavior that could be affected by the change, such as: | ||
|
|
||
| - Related block controls | ||
| - Save and reload behavior | ||
| - Editor UI states (selected, focused, transformed) | ||
| - Frontend output (if relevant) | ||
|
|
||
| ### 5) Report results | ||
|
|
||
| Add a short test report in the ticket or PR with: | ||
|
|
||
| - Environment used (WordPress Playground + Gutenberg active) | ||
| - Baseline result (before fix) | ||
| - After-fix result | ||
| - Regression checks performed | ||
| - Any follow-up observations | ||
|
|
||
| ## Suggested test report template | ||
|
|
||
| Use this template for consistent reporting: | ||
|
khushdoms marked this conversation as resolved.
Outdated
|
||
|
|
||
| ```md | ||
| ### Playground test report | ||
|
|
||
| - Ticket: <ticket URL> | ||
| - PR/Patch tested: <PR or patch URL> | ||
| - Environment: WordPress Playground, Gutenberg plugin active | ||
|
|
||
| #### Baseline (before fix) | ||
| - Steps followed: | ||
| 1. ... | ||
| 2. ... | ||
| - Actual result: ... | ||
| - Expected result: ... | ||
|
|
||
| #### After applying fix | ||
| - Result: ... | ||
|
|
||
| #### Regression checks | ||
| - Checked: ... | ||
| - Result: ... | ||
|
|
||
| #### Notes | ||
| - ... | ||
| ``` | ||
|
|
||
| ## Example scenario | ||
|
|
||
| 1. Open the linked ticket and copy the exact reproduction steps. | ||
| 2. Reproduce the bug in Playground with Gutenberg active. | ||
| 3. Save the baseline result (for example: control missing, incorrect transform, unexpected warning). | ||
| 4. Apply the linked patch/PR and repeat the exact steps. | ||
| 5. Confirm the issue is resolved and validate one or two related editor flows for regressions. | ||
| 6. Post the test report using the template above. | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.