Align testing docs with current test setup#393
Align testing docs with current test setup#393ekamran wants to merge 2 commits intoWordPress:developfrom
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 If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #393 +/- ##
==========================================
Coverage 62.64% 62.64%
Complexity 681 681
==========================================
Files 49 49
Lines 3515 3515
==========================================
Hits 2202 2202
Misses 1313 1313
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
What?
Follow up to contributor documentation cleanup.
Updates the testing and contributor documentation so it matches the repository's current test setup.
Why?
The docs were referencing test structure and commands that do not match the current repository state. In particular:
docs/TESTING.mdreferenced atests/Unit/suite that does not currently exist.composer stan, while the repo currently exposescomposer phpstan.This can confuse first-time contributors and make setup feel broken even when the issue is only outdated documentation.
How?
docs/TESTING.mdto reflect the current PHPUnit configuration.integrationsuite.composer stantocomposer phpstan.docs/DEVELOPER_GUIDE.mdso contributors are directed to the existingtests/Integration/suite instead of a non-existenttests/Unit/directory.Use of AI Tools
I used AI assistance to help inspect the repository, identify outdated documentation, and draft the documentation updates. I manually reviewed the repository structure, verified the current test configuration, and reviewed the final changes before submitting.
Testing Instructions
docs/TESTING.mdno longer claims the repository currently contains atests/Unit/suite.tests/Integration/.composer phpstan.Testing Instructions for Keyboard
Screenshots or screencast
Not applicable.
tests/Unit/suite and outdated PHPUnit commands.