[wp-meta] [Making WordPress.org] #5652: Plugin Readme Header Spec Upgrade

[Making WordPress.org]

#5652: Plugin Readme Header Spec Upgrade
------------------------------+---------------------
 Reporter:  pewgeuges         |       Owner:  (none)
     Type:  defect            |      Status:  new
 Priority:  normal            |   Milestone:
Component:  Plugin Directory  |  Resolution:
 Keywords:                    |
------------------------------+---------------------

Comment (by Otto42):

 Replying to [comment:2 pewgeuges]:
 > Replying to [comment:1 Otto42]:
 > > The moment we add explanatory text in the example is the same moment
 when the plugin review team will start seeing it in submitted plugin's
 readme files.
 >
 > That’s cool, thanks. Implies that it’s safe to add this needed extra
 information in the header.

 I think you misread what I meant.

 If we change the example to have "CAUTION: THE S. T. FIELD IS PARSED FOR
 RELEASE CONFIGURATION." in it, then what we're going to get is readme's
 that have that exact text in it. Unchanged.

 If we put "Stable Tag: [plugin version]" then we will get people asking
 why their ZIPs have [plugin version] in it. And similar.

 People don't make changes where you want them to make those changes. We
 get submitted plugins with "=== Plugin Name ===" in them all the time,
 because people don't put their plugin name in the first line of the readme
 file.

 So explanatory text will be ignored and people will simply submit it with
 that text there. Your approach, while understandable, doesn't seem like a
 thing that will work to me.

-- 
Ticket URL: <https://meta.trac.wordpress.org/ticket/5652#comment:4>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org