Skip to content
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

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

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from

Conversation

q0rban
Copy link

@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.

Copy link

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: @q0rban.

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

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

Copy link

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

Copy link

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

@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!

Comment on lines +9 to +11
1. Check out the wordpress-develop repository

git clone git://develop.git.wordpress.org/ wordpress-develop

Choose a reason for hiding this comment

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

Suggested change
1. Check out the wordpress-develop repository
git clone git://develop.git.wordpress.org/ wordpress-develop
1. Check out the [`wordpress-develop` repository](https://github.com/WordPress/wordpress-develop):
git clone git@github.com:WordPress/wordpress-develop.git

I wonder if this should instead refer to the Github repo, as PRs there are the typical way to contribute patches and tests.

git clone git://develop.git.wordpress.org/ wordpress-develop
cd wordpress-develop

2. Run `composer update --with-all-dependencies`

Choose a reason for hiding this comment

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

Suggested change
2. Run `composer update --with-all-dependencies`
2. Run `composer update --with-all-dependencies`.

Nit.

Comment on lines +18 to +23
- To execute a particular test:

$ vendor/bin/phpunit tests/phpunit/tests/test_case.php
- To execute all tests:

$ vendor/bin/phpunit

Choose a reason for hiding this comment

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

Suggested change
- To execute a particular test:
$ vendor/bin/phpunit tests/phpunit/tests/test_case.php
- To execute all tests:
$ vendor/bin/phpunit
- To execute a particular test:
vendor/bin/phpunit tests/phpunit/tests/test_case.php
- To execute all tests:
vendor/bin/phpunit

Suggest dropping the terminal prompt character. For these commands, please substitute the block formatting spaces by wrapping with three backticks for consistency with other docs (I'm unsure how to add these within a backticked suggestion block 😅).

1. Check out the wordpress-develop repository

git clone git://develop.git.wordpress.org/ wordpress-develop
cd wordpress-develop

Choose a reason for hiding this comment

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

Suggested change
cd wordpress-develop
cd wordpress-develop

For this and the git clone line above it, please wrap with three backticks instead of spaces (for example).

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.

2 participants