Skip to content

docs: update PHPUnit testing README.md with corrections #62065#7389

Closed
q0rban wants to merge 5 commits intoWordPress:trunkfrom
q0rban:62065--phpunit-readme-update
Closed

docs: update PHPUnit testing README.md with corrections #62065#7389
q0rban wants to merge 5 commits intoWordPress:trunkfrom
q0rban:62065--phpunit-readme-update

Conversation

@q0rban
Copy link
Copy Markdown

@q0rban q0rban commented Sep 17, 2024

Correct the in-repo PHPUnit testing instructions, and switch to Markdown.

Trac ticket: https://core.trac.wordpress.org/ticket/62065


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Sep 17, 2024

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.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @james@lullabot.com, @juampick.

Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases.

Core Committers: Use this line as a base for the props when committing in SVN:

Props q0rban, ironprogrammer, desrosj.

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

@github-actions
Copy link
Copy Markdown

Hi @q0rban! 👋

Thank you for your contribution to WordPress! 💖

It looks like this is your first pull request to wordpress-develop. Here are a few things to be aware of that may help you out!

No one monitors this repository for new pull requests. Pull requests must be attached to a Trac ticket to be considered for inclusion in WordPress Core. To attach a pull request to a Trac ticket, please include the ticket's full URL in your pull request description.

Pull requests are never merged on GitHub. The WordPress codebase continues to be managed through the SVN repository that this GitHub repository mirrors. Please feel free to open pull requests to work on any contribution you are making.

More information about how GitHub pull requests can be used to contribute to WordPress can be found in the Core Handbook.

Please include automated tests. Including tests in your pull request is one way to help your patch be considered faster. To learn about WordPress' test suites, visit the Automated Testing page in the handbook.

If you have not had a chance, please review the Contribute with Code page in the WordPress Core Handbook.

The Developer Hub also documents the various coding standards that are followed:

Thank you,
The WordPress Project

@github-actions
Copy link
Copy Markdown

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Copy link
Copy Markdown
Member

@ironprogrammer ironprogrammer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for running through and testing the PHPUnit setup, and helping improve the docs, @q0rban! I've left a few suggestions below.

Also, don't forget to link your GH and WPORG accounts so you can get your props!

@q0rban q0rban force-pushed the 62065--phpunit-readme-update branch from 79434dd to 95bb825 Compare February 18, 2025 13:53
@q0rban
Copy link
Copy Markdown
Author

q0rban commented Feb 18, 2025

@ironprogrammer thank you for the review! Apologies for the delay in my addressing your feedback. I believe I've got your suggestions addressed, however I did run into a slight issue switching to backticks while preserving proper indentation. Let me know if you would like me to try to format this in a different way.

Copy link
Copy Markdown
Member

@ironprogrammer ironprogrammer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The updates look good, @q0rban!

(One thing I noticed this round was that on line 5 the link for "PHP: PHP Unit" has a space there, but it should be "PHP: PHPUnit". I don't want to block this any further, so just mentioning it and giving my thumbs up in the meantime! 👍🏻 I can drop a short note on the Trac ticket and add it to the 6.8 milestone once that's updated.)

@q0rban
Copy link
Copy Markdown
Author

q0rban commented Feb 20, 2025

I couldn't resist fixing the typo. Good catch!

Copy link
Copy Markdown
Member

@desrosj desrosj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left some suggestions, but while reviewing I realized we're creating an additional place for our documentation to become out of date.

What if we included the intro paragraph and then just linked out to the handbook for setup instructions? Is there a reason we must include setup instructions in this file?

q0rban and others added 2 commits March 12, 2025 15:59
Co-authored-by: Jonathan Desrosiers <359867+desrosj@users.noreply.github.com>
@q0rban
Copy link
Copy Markdown
Author

q0rban commented Aug 26, 2025

Updated with a simplified version that links away to relevant Handbook pages.

Copy link
Copy Markdown
Member

@ironprogrammer ironprogrammer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍🏻

Copy link
Copy Markdown

@juampick juampick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@github-actions
Copy link
Copy Markdown

A commit was made that fixes the Trac ticket referenced in the description of this pull request.

SVN changeset: 60674
GitHub commit: aec4b3c

This PR will be closed, but please confirm the accuracy of this and reopen if there is more work to be done.

@github-actions github-actions bot closed this Aug 26, 2025
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.

4 participants