WordPress / test-handbook

Make WordPress Test Handbook
https://make.wordpress.org/test/handbook/
8 stars 6 forks source link

Create Markdown text version of each report type #3

Open ironprogrammer opened 1 year ago

ironprogrammer commented 1 year ago

The current example copy & paste test reports are in WikiFormatting format. Because a significant amount of testing happens in GitHub as well, adding copy & paste Markdown snippets could help streamline and make GitHub test contributions more uniform.

Additional Benefit

In Trac, these WikiFormatting snippets are rendered with heading tags and id attributes, which can be used to scan for test instructions, or more reliably identify test contributions for awarding profile badges. For instance:

<h2 id="TestReport">Test Report</h2>
<h3 id="StepstoTest">Steps to Test</h3>
...
<h2 id="ReproductionReport">Reproduction Report</h2>
<h3 id="StepstoReproduce">Steps to Reproduce</h3>

By encouraging consistent report formats in GitHub, there is a similar benefit that could be derived from reports submitted to issues and PRs:

<h2 dir="auto">Test Report</h2>
<h3 dir="auto">Steps to Test</h2>
...
<h2 dir="auto">Reproduction Report</h2>
<h3 dir="auto">Steps to Reproduce</h2>

(The above snippets are automatically generated for comments in their respective environments.)

lancewillett commented 1 month ago

As a note, the Test Reports plugin will also need an update to add Markdown support: https://wordpress.org/plugins/test-reports/

ironprogrammer commented 1 month ago

As a note, the Test Reports plugin will also need an update to add Markdown support: wordpress.org/plugins/test-reports

When the "Report Location" option is toggled, it looks like the plugin already has this handled (whew!)

test-reports plugin report location markup syntax toggle

This has also been accounted for in the WordPress Beta Tester plugin (screenshot).

Thanks, @lancewillett, for keeping an eye out for where else this update would apply! 🙌🏻