[wp-meta] [Making WordPress.org] #3675: Readme validator for plugins appears to be broken

Making WordPress.org noreply at wordpress.org
Thu Jun 21 14:12:07 UTC 2018

#3675: Readme validator for plugins appears to be broken
 Reporter:  duanestorey        |       Owner:  (none)
     Type:  defect             |      Status:  closed
 Priority:  normal             |   Milestone:
Component:  Plugin Directory   |  Resolution:  invalid
 Keywords:  reporter-feedback  |

Comment (by duanestorey):

 I'm not sure if this happens enough to do something about it, but a simple
 change in the validator that looks for that original string and gives a
 different error message might be useful.  For example the error message
 now is:

 ''No plugin name detected. Plugin names look like: === Plugin Name ===''

 Perhaps something more like:

 ''You need to add your plugin's name to the readme file; please change
 '=== Plugin Name ===' to reflect the actual name of your plugin, for
 example '=== Tony's Great Image Plugin ==='''

 or something that makes it more obvious?  Just a suggestion in an attempt
 to reduce these issues if you do see this more often.

 Replying to [comment:6 Otto42]:
 > To explain this more clearly to anybody else reading this ticket, many
 people don't quite grasp the idea here, and leave the literal text of "===
 Plugin Name ===" there in the readme.txt file. We see it happen all the
 time in committed code.
 > So, the checker is checking for that specific text. You're supposed to
 replace the words "Plugin Name" with the actual name of your plugin. If
 you don't do that, then you get the error in question.
 > You should actually not have "=== Plugin Name ===" there, but instead
 have three equal signs, the actual name of your plugin, and then three
 more equal signs.

Ticket URL: <https://meta.trac.wordpress.org/ticket/3675#comment:7>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org

More information about the wp-meta mailing list