docs: update PHPUnit testing README.md with corrections #62065#7389
docs: update PHPUnit testing README.md with corrections #62065#7389q0rban wants to merge 5 commits intoWordPress:trunkfrom
Conversation
|
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 Unlinked AccountsThe 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: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Hi @q0rban! 👋 Thank you for your contribution to WordPress! 💖 It looks like this is your first pull request to 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, |
Test using WordPress PlaygroundThe 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
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
There was a problem hiding this comment.
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!
79434dd to
95bb825
Compare
|
@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. |
ironprogrammer
left a comment
There was a problem hiding this comment.
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.)
|
I couldn't resist fixing the typo. Good catch! |
desrosj
left a comment
There was a problem hiding this comment.
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?
Co-authored-by: Jonathan Desrosiers <359867+desrosj@users.noreply.github.com>
|
Updated with a simplified version that links away to relevant Handbook pages. |
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.