[wp-meta] [Making WordPress.org] #6108: Add automated guideline checks and constant feedback to plugin authors about it

Making WordPress.org noreply at wordpress.org
Wed Feb 16 02:29:46 UTC 2022


#6108: Add automated guideline checks and constant feedback to plugin authors
about it
------------------------------+---------------------
 Reporter:  dd32              |       Owner:  (none)
     Type:  defect            |      Status:  new
 Priority:  low               |   Milestone:
Component:  Plugin Directory  |  Resolution:
 Keywords:                    |
------------------------------+---------------------
Description changed by dd32:

Old description:

> Currently a lot of plugin guidelines are enforced purely through manual
> processes by reviewers, often in response to complaints/contact from
> others.
>
> It would be ideal if we had a system similar to
> [https://wordpress.org/plugins/theme-check/ "Theme Check"] where
> automated checks are run over each plugin commit/release.
>
> This could be used to flag serious issues:
>  - ERROR: Your plugin name should not include the terms 'WordPress' or
> 'Plugin'.
>  - ERROR: Your plugin name should not need to be 50 words
>
> Feedback on user errors:
>  - WARNING: You included 'John Smith' within your 'Contributors:' line in
> your readme, this should only include WordPress.org usernames of
> developers, not real names.
>
> and less-serious, but annoying things:
>  - NOTICE: screenshot-1.png is 4MB in size, consider optimizing it.
>  - INFO: Your plugin includes screenshots in the plugin folder, rather
> than using assets, this results in 5MB extra files within your plugin
> ZIP.
>
> Due to the different flow for Plugins verse Theme updates, the results of
> this would need to be handled differently.
>
> My thoughts are a combination of the following:
>  - Email to the plugin committers post-version-update
>  - Displayed at the top of the Plugins page for plugin committers only
>    - and/or Displayed on the Development tab for plugin committers, and
> everyone else.
>  - Logged to a Slack channel, similar to #themereview-firehose and #meta-
> language-packs

New description:

 Currently a lot of plugin guidelines are enforced purely through manual
 processes by reviewers, often in response to complaints/contact from
 others.

 It would be ideal if we had a system similar to
 [https://wordpress.org/plugins/theme-check/ "Theme Check"] where automated
 checks are run over each plugin commit/release.

 This could be used to flag serious issues:
  - ERROR: Your plugin name should not include the terms 'WordPress' or
 'Plugin'.
  - ERROR: Your plugin name should not need to be 50 words

 Feedback on user errors:
  - WARNING: You included 'John Smith' within your 'Contributors:' line in
 your readme, this should only include WordPress.org usernames of
 developers, not real names.
  - WARNING: Your plugin slug is 'my-cool-plugin', your textdomain should
 be the same to be compatible with translations from
 translate.wordpress.org. Detected 'dd-text'.

 and less-serious, but annoying things:
  - NOTICE: screenshot-1.png is 4MB in size, consider optimizing it.
  - INFO: Your plugin includes screenshots in the plugin folder, rather
 than using assets, this results in 5MB extra files within your plugin ZIP.

 Due to the different flow for Plugins verse Theme updates, the results of
 this would need to be handled differently.

 My thoughts are a combination of the following:
  - Email to the plugin committers post-version-update
  - Displayed at the top of the Plugins page for plugin committers only
    - and/or Displayed on the Development tab for plugin committers, and
 everyone else.
  - Logged to a Slack channel, similar to #themereview-firehose and #meta-
 language-packs

--

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


More information about the wp-meta mailing list