Make WordPress Core

Opened 9 months ago

Last modified 3 months ago

#62065 new defect (bug)

Update in-repo PHPUnit documentation

Reported by: q0rban's profile q0rban Owned by:
Milestone: 6.9 Priority: normal
Severity: normal Version:
Component: Build/Test Tools Keywords: has-patch reporter-feedback
Focuses: docs Cc:

Description

The current PHPUnit documentation that lives in /tests/phpunit/README.txt is out of date. It contains incorrect testing steps, and should ideally be in Markdown like other in-repo documentation. It could also benefit from a link to the more detailed handbook page.

Change History (8)

This ticket was mentioned in PR #7389 on WordPress/wordpress-develop by q0rban.


9 months ago
#1

  • Keywords has-patch has-unit-tests added

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

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

This ticket was mentioned in Slack in #core-test by q0rban. View the logs.


9 months ago

@q0rban commented on PR #7389:


4 months ago
#3

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

@q0rban commented on PR #7389:


4 months ago
#4

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

#5 @ironprogrammer
4 months ago

  • Keywords has-unit-tests removed
  • Milestone changed from Awaiting Review to 6.8
  • Version changed from 6.7 to trunk

This update LGTM 👍🏻 Moving into 6.8 milestone for consideration.

#6 @desrosj
3 months ago

  • Keywords reporter-feedback added
  • Version trunk deleted

Copying my review message here to make the status obvious on Trac:

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?

Removing trunk version as this is not a new bug.

#7 @peterwilsoncc
3 months ago

[...] 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?

I like this suggestion, in [55670] the security policy in the repository was updated to refer developers to Hacker1 as the source of truth. I think it would be good to treat the handbook as the source of truth for running tests.

#8 @desrosj
3 months ago

  • Milestone changed from 6.8 to 6.9

This is not critical to the 6.8 release, so I'm going to move it so that the feedback can be addressed.

Note: See TracTickets for help on using tickets.