When the plugin has both a README.md and a readme.txt in the root directory the README.md is used preferentially as it is the first item in the array from plugin-check.php lines 86-91
if ( ! $args['readme'] ) {
$readme_files = preg_grep( '!(^|/)readme.(txt|md)$!i', $top_level_files );
if ( $readme_files ) {
$args['readme'] = new Readme_Parser( array_shift( $readme_files ) );
}
}
Personally, I have a README.md for GitHub and a readme.txt for the plugin repo.
It would make the most sense to use the readme.txt if it exists and fallback to README.md.
Steps to Reproduce
Use the WordPress Beta Tester plugin as an example.
BTW the Environment info comes from the Test Reports plugin, which is still awaiting review. 😉
Describe the bug
When the plugin has both a README.md and a readme.txt in the root directory the README.md is used preferentially as it is the first item in the array from plugin-check.php lines 86-91
Personally, I have a README.md for GitHub and a readme.txt for the plugin repo.
It would make the most sense to use the
readme.txt
if it exists and fallback toREADME.md
.Steps to Reproduce
Use the WordPress Beta Tester plugin as an example.
BTW the Environment info comes from the Test Reports plugin, which is still awaiting review. 😉
Screenshots, screen recording, code snippet
No response
Environment information
Bug Report
Description
Describe the bug.
Environment
Steps to Reproduce
Expected Results
Actual Results
Additional Notes
Supplemental Artifacts
Add as Attachment
WordPress information
No response
Code of Conduct