WordPress.org

Making WordPress.org

Opened 9 months ago

Closed 9 months ago

Last modified 8 months ago

#3080 closed defect (invalid)

The sample plugin readme file fails the readme validator

Reported by: johnbillion Owned by:
Milestone: Priority: normal
Component: Plugin Directory Keywords:
Cc:

Description

At the bottom of https://wordpress.org/plugins/developers/, a link to the "WordPress plugin readme file standard" is provided. This links to a readme file which itself fails the readme validator at https://wordpress.org/plugins/developers/readme-validator/.

Fatal Errors:
No plugin name detected. Plugin names look like: === Plugin Name ===
Warnings:
Requires PHP is missing.
No Contributors listed.

Change History (5)

#1 @Ipstenu
9 months ago

It works if you change it to === MY Plugin Name ===

Hah. Okay, we should change the error to flag that as the default ;)

This ticket was mentioned in Slack in #docs by joyously. View the logs.


9 months ago

#3 follow-up: @Otto42
9 months ago

  • Resolution set to invalid
  • Status changed from new to closed

The plugin name fails because we specifically have the validator looking for the sample "plugin name" header because authors frequently forget to change that and thus call their plugin "Plugin Name".

The Requires PHP thing is new. And there are no Contributors because there is an instruction to put in contributor ID's there instead.

#4 in reply to: ↑ 3 @SergeyBiryukov
9 months ago

  • Keywords needs-patch removed

Requires PHP is missing.

This was not intentional, it should not be a required header. Added a patch on #2952 to remove it from the validator.

#5 @SergeyBiryukov
8 months ago

This was not intentional, it should not be a required header.

On second thought and after some discussions in #2952 and #core-php, the new header should be added to the readme standard. Created #3123 for that.

Note: See TracTickets for help on using tickets.