Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DevHub] Since Require at least and Require PHP are not mandatory to add readme header file #1831

Open
shsajalchowdhury opened this issue Jan 24, 2025 · 4 comments
Labels
developer documentation (DevHub) Improvements or additions to developer documentation plugins Issues for Plugin Developer Handbook [Status] To do Issue marked as Todo

Comments

@shsajalchowdhury
Copy link

Issue Description

Recently, in the plugin review, it was required to remove the Require at least, and the Require PHP version, but the guide link sent by the plugin review team was not updated. The guide page still has outdated readme files.

I have attached the guide link that needs to be updated. The readme validator still notices that Require at least and Require PHP are missing.

Image

URL of the Page with the Issue

https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/
https://wordpress.org/plugins/developers/readme-validator/

Section of Page with the issue

Readme header information section

Suggested Fix

Update the Readme header as per the latest update

@shsajalchowdhury shsajalchowdhury added the [Status] To do Issue marked as Todo label Jan 24, 2025
Copy link

Heads up @WordPress/docs-issues-coordinators, we have a new issue open. Time to use 'em labels.

@atachibana atachibana added the plugins Issues for Plugin Developer Handbook label Jan 28, 2025
@github-actions github-actions bot added the developer documentation (DevHub) Improvements or additions to developer documentation label Jan 28, 2025
Copy link

Heads up @theMikeD - the "plugins" label was applied to this issue.

@dd32
Copy link
Member

dd32 commented Feb 13, 2025

FYI @WordPress/plugin-review-team

https://wordpress.slack.com/archives/C1LBM36LC/p1739419373629879

Posted by dd32
I’m not sure that’s valid, in that the suggestion needs to be removed, as those headers don’t need to be removed.

I think the confusion is that it can be defined in either the Readme.txt or the plugin.php file, with the latter also read by core.

The field is optional to include inside the readme.txt as a result. That’s why it’s only a Note not a Warning or Error in the validator (which doesn’t know about the header being included in the plugin.php file)

The github repo you’ve mentioned is for Docs team, which isn’t the plugin team who generally manages plugins related stuff.

@ernilambar
Copy link
Member

Related WordPress/plugin-check#866

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer documentation (DevHub) Improvements or additions to developer documentation plugins Issues for Plugin Developer Handbook [Status] To do Issue marked as Todo
Projects
None yet
Development

No branches or pull requests

4 participants