Update reproduction and patch testing report templates by huzaifaalmesbah · Pull Request #166 · WordPress/test-handbook

huzaifaalmesbah · 2026-05-16T02:50:54Z

Summary

Proposed changes to the Reproduction and Patch Testing report templates as discussed in #104.

Changes to both templates

Environment: Reordered fields (WordPress first), added Database and MU Plugins
Steps taken: Replaces "Actual Results" — result shown as the last numbered step (🐞/✅/❌)
Expected behavior/result: New section for describing expected outcomes
Screenshots/Screencast with results: Dedicated section (with before/after for patch testing)
Support Content: New section for Blueprint JSON, Playground URLs, code snippets, etc.
Trac template / GitHub template: Consistent subheadings for both versions, replaced <pre><code> with fenced code blocks for the Trac template

Patch testing specific

Merged the two separate Bug/Defect and Feature/Enhancement templates into a single unified Patch Testing Report Template

Closes #104

Test plan

Verify both Trac and GitHub templates render correctly in the handbook
Confirm all new fields (Database, MU Plugins, Support Content) are present in both templates
Check that the unified patch testing template covers both bug/defect and feature/enhancement use cases

🤖 Generated with Claude Code

Restructure both templates with new fields (Database, MU Plugins, Support Content), replace Actual Results with Steps taken, and unify patch testing into a single template.

github-actions · 2026-05-16T02:51:02Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: huzaifaalmesbah <huzaifaalmesbah@git.wordpress.org>
Co-authored-by: ozgursar <ozgursar@git.wordpress.org>
Co-authored-by: nikunj8866 <nikunj8866@git.wordpress.org>
Co-authored-by: 3kori <r1k0@git.wordpress.org>
Co-authored-by: Successfulsebunya <mosescursor@git.wordpress.org>
Co-authored-by: SirLouen <sirlouen@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

nikunj8866

@huzaifaalmesbah Great work on this handbook page! I'd like to suggest adding a dedicated section that points contributors to the Test Reports plugin, so they don't have to fill out the environment details manually.

This would sit right before the Report Template section, so readers see the automated option first.

Proposed section

## Generating Reports with the Test Reports Plugin

Instead of filling out the template manually, you can use the **Test Reports** plugin to auto-generate reproduction reports pre-filled with your environment details.

### What it does

The plugin automatically captures your WordPress version, PHP version, active theme, plugins, browser, and OS - eliminating manual data entry for the Environment section.

### Where to get it

Install **Test Reports** directly from:  (https://github.com/WPContrib/test-reports/archive/refs/tags/0.1.0.zip)

### How to use it

1. Install and activate the plugin on your test site.
2. Navigate to the Tools > Test Reports.
3. Select the Report Location (Trac or GitHub) - the plugin will format the output accordingly.
5. Fill in only the fields that require manual input: **Steps taken**, **Expected behavior**, and **Additional Notes**.

### Tips

- For **GitHub issues**, the plugin outputs Markdown-formatted reports ready to paste directly.
- For **Trac tickets**, the plugin outputs Wiki-formatted reports compatible with Trac's syntax.
- Always review the auto-filled environment details before posting to confirm accuracy.

Why this helps:

Reduces friction for contributors - especially newcomers who may be unfamiliar with all the environment fields.
Ensures more consistent and complete environment data across reports.
The manual templates remain useful as a reference for understanding what the plugin captures.

Happy to adjust the wording or placement if needed!

huzaifaalmesbah · 2026-05-18T12:54:28Z

Install Test Reports directly from: (https://github.com/WPContrib/test-reports/archive/refs/tags/0.1.0.zip)

@nikunj8866 Thanks for the suggestion! I agree that pointing contributors to the Test Reports plugin is helpful. However, I already have a PR on the original plugin to update the templates to match this handbook format: afragen/test-reports#6

I think we can either use the original plugin URL or skip this section for now. Once the PR is merged, we can add the full section with the official wordpress.org plugin link. What do you think?

nikunj8866 · 2026-05-19T12:03:04Z

@huzaifaalmesbah That makes sense.

I've already pinged Andy Fragen and @costdev to review and merge afragen/test-reports#6, so I'd suggest we wait a few days to see if it gets merged. If it does, we can update this PR to include the full section with the official wordpress.org plugin link - which would be the cleanest outcome.

If we don't hear back in time, I think we have two reasonable paths:

Merge this PR as-is (without the plugin section) and add it in a follow-up PR once the plugin is updated and published on wordpress.org.
Include the section now with our forked build as a temporary reference: WPContrib/test-reports v0.1.0 - and update the link once the upstream PR is merged.

I'm leaning toward option 1 to keep things clean, but happy to go with whatever the team prefers. What do you think?

3kori

This PR is ready to go as is. If the PR to the test report plugin isn't merged any time soon, we can go with option 1 by @nikunj8866

nikunj8866 · 2026-05-20T04:19:21Z

I got this response from Andy Fragen.

Per PR review feedback, add a "Generating Reports with the Test Reports Plugin" section directing contributors to the plugin before the manual templates.

huzaifaalmesbah · 2026-05-20T15:48:32Z

Andy Fragen has merged our PR and published a new release of the Test Reports plugin. I've updated this PR per @nikunj8866's suggestion. added the "Generating Reports with the Test Reports Plugin" section with install link, steps, and screenshots to both reproduction and patch testing pages.

This PR is ready for review. Let me know if any changes are needed!

3kori

LGTM!

Update reproduction and patch testing report templates

276923b

Restructure both templates with new fields (Database, MU Plugins, Support Content), replace Actual Results with Steps taken, and unify patch testing into a single template.

huzaifaalmesbah self-assigned this May 16, 2026

huzaifaalmesbah added the Needs: 2 Reviews label May 16, 2026

huzaifaalmesbah mentioned this pull request May 18, 2026

Update Bug Reproduction and Patch Testing templates per test-handbook#104 afragen/test-reports#6

Merged

9 tasks

ozgursar approved these changes May 18, 2026

View reviewed changes

huzaifaalmesbah requested review from 3kori, Successfulsebunya and nikunj8866 May 18, 2026 11:38

nikunj8866 reviewed May 18, 2026

View reviewed changes

3kori reviewed May 20, 2026

View reviewed changes

Add Test Reports plugin section to reproduction and patch testing pages

8712bb3

Per PR review feedback, add a "Generating Reports with the Test Reports Plugin" section directing contributors to the plugin before the manual templates.

huzaifaalmesbah requested review from 3kori, nikunj8866 and ozgursar May 20, 2026 15:48

nikunj8866 approved these changes May 21, 2026

View reviewed changes

nikunj8866 added Needs: 1 Review and removed Needs: 2 Reviews labels May 21, 2026

3kori approved these changes May 21, 2026

View reviewed changes

nikunj8866 merged commit 2c36b0b into WordPress:trunk May 21, 2026
4 checks passed

huzaifaalmesbah mentioned this pull request May 25, 2026

In Key Test Report Features, define "expected" and "actual" test results #2

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update reproduction and patch testing report templates#166

Update reproduction and patch testing report templates#166
nikunj8866 merged 2 commits into
WordPress:trunkfrom
huzaifaalmesbah:update/104-test-report-templates

huzaifaalmesbah commented May 16, 2026 •

edited by ozgursar

Loading

Uh oh!

github-actions Bot commented May 16, 2026 •

edited

Loading

Uh oh!

nikunj8866 left a comment •

edited

Loading

Uh oh!

huzaifaalmesbah commented May 18, 2026

Uh oh!

nikunj8866 commented May 19, 2026 •

edited

Loading

Uh oh!

3kori left a comment

Uh oh!

nikunj8866 commented May 20, 2026

Uh oh!

huzaifaalmesbah commented May 20, 2026

Uh oh!

3kori left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

huzaifaalmesbah commented May 16, 2026 • edited by ozgursar Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes to both templates

Patch testing specific

Test plan

Uh oh!

github-actions Bot commented May 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nikunj8866 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Proposed section

Uh oh!

huzaifaalmesbah commented May 18, 2026

Uh oh!

nikunj8866 commented May 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

3kori left a comment

Choose a reason for hiding this comment

Uh oh!

nikunj8866 commented May 20, 2026

Uh oh!

huzaifaalmesbah commented May 20, 2026

Uh oh!

3kori left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

huzaifaalmesbah commented May 16, 2026 •

edited by ozgursar

Loading

github-actions Bot commented May 16, 2026 •

edited

Loading

nikunj8866 left a comment •

edited

Loading

nikunj8866 commented May 19, 2026 •

edited

Loading