[wp-meta] [Making WordPress.org] #2743: Improvement of New Readme Validator

[Making WordPress.org]

#2743: Improvement of New Readme Validator
------------------------------+-----------------------------------------
 Reporter:  Asif2BD           |      Owner:
     Type:  enhancement       |     Status:  new
 Priority:  high              |  Milestone:
Component:  Plugin Directory  |   Keywords:  needs-patch has-screenshots
------------------------------+-----------------------------------------
 Otto explained this validator is still new and could use some improvement,
 I personally think it needs some basic feature, right now it's just
 checking if there is a contributor or if there is an upgrade notice. What
 about formatting proper markdown? Like what if the format is wrong, or the
 name is too long? Ultimately though validator is not a real-time scanner,
 still its a good guide for a new developer. They might get the wrong msz
 about plugin directory best practice.

 You can find the current validator code
 [here](https://meta.trac.wordpress.org/browser/sites/trunk/wordpress.org/public_html
 /wp-content/plugins/plugin-directory/readme)

 I propose the following Improvement -

 1) Let's show a preview of the entered readme.txt

 2) Instead of just checking if a block exist like this

 {{{
 if ( ! count( $readme->contributors ) ) {
                                 /* Translators: Plugin header tag; */
                                 $warnings[] = sprintf( __( 'No %s
 listed.', 'wporg-plugins' ), '<code>Contributors</code>' );
                         }

 }}}

 We should check the size of a section, is the format is ok, like all the
 format is closed properly.

 3) Give feedbacks like Plugin Name is too wrong, or must have at least one
 screenshot.

 4) Instead of just showing md style format, is it possible to show styles
 with present Plugin Directory?

 This is based on my conversation with @otto42 & @sergey, check this [slack
 archives](https://wordpress.slack.com/archives/C02QB8GMM/p1492199946799705).

--
Ticket URL: <https://meta.trac.wordpress.org/ticket/2743>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org