Make WordPress Core

Opened 2 years ago

Closed 13 months ago

#62065 closed defect (bug) (fixed)

Update in-repo PHPUnit documentation

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

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 (17)

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


2 years 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.


2 years ago

@q0rban commented on PR #7389:


19 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:


19 months ago
#4

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

#5 @ironprogrammer
19 months ago

  • Keywords has-unit-tests removed
  • Milestone Awaiting Review6.8
  • Version 6.7trunk

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

#6 @desrosj
18 months ago

  • Keywords reporter-feedback added
  • Version trunk

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
18 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
18 months ago

  • Milestone 6.86.9

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

#9 @jorbin
13 months ago

  • Keywords needs-patch added; has-patch removed
  • Owner set to juampick
  • Status newassigned

Assigning to @juampick who has agreed to help with this at WCUS25 contributor day.

#10 @q0rban
13 months ago

Fantastic! I have pushed up the requested changes to the GitHub pull request if you would like to review there @juampick.

@q0rban commented on PR #7389:


13 months ago
#11

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

juampick commented on PR #7389:


13 months ago
#12

Looks good! thanks @q0rban

@juampick commented on PR #7389:


13 months ago
#13

Looks good! thanks @q0rban

#14 @jorbin
13 months ago

  • Resolutionfixed
  • Status assignedclosed

In 60674:

Build/Test Tools: Update in-repo PHPUnit documentation to point to a single source of truth.

Props q0rban, ironprogrammer, desrosj, peterwilsoncc, juampick.
Fixes #62065.

#15 @jorbin
13 months ago

  • Resolution fixed
  • Status closedreopened

Reopening since the owner can't be changed on a closed ticket

#16 @jorbin
13 months ago

  • Owner changed from juampick to jorbin
  • Status reopenedassigned

#17 @jorbin
13 months ago

  • Resolutionfixed
  • Status assignedclosed
Note: See TracTickets for help on using tickets.