WordPress / WordPress/performance
Improve code coverage through annotations
@sarthak-19 is already working on this.
Since Jan 12, 2025.
- Dominant language
- PHP
- Stars
- 461
- Forks
- 165
- Avg merge
- 11h 12m
- Merged PRs (30d)
- 28
Description
The current code coverage metrics are as follows :
and can be improved by addressing the following issues:
-
Ignore Coverage for Non-Critical Code Blocks:
-
Certain ubiquitous code blocks, such as:
if ( ! defined( 'ABSPATH' ) ) { exit; }These blocks can be excluded from code coverage by adding
// @codeCoverageIgnoreStartand// @codeCoverageIgnoreEndannotations.
-
-
Exclude Plugin Bootstrap Files from Coverage:
- Files like plugin bootstrap files only include logic that is already tested elsewhere.
- Evaluate marking
uninstall.phpas indirectly tested and decide whether similar exclusions are needed for files likehooks.php.
-
Add Missing
@coversAnnotations:- Ensure all tests have proper
@coversannotations to map them to the code they validate. For instance:\Test_OD_URL_Metric::test_constructoris missing a@covers ::get_uuidannotation.
- Ensure all tests have proper
-
Add Missing Tests:
- Identify areas of the codebase that are not currently tested and write additional tests to improve overall coverage.
These changes aim to focus coverage metrics on critical functionality and ensure more accurate and meaningful reports, improving code quality and maintainability.
cc : @westonruter
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.