Plugin readme file mess

Support
6

Btw
I’ve suggested this once already here Ditch readme.txt in favour of readme.md
Might have good info in there

And, it’s not surprising that we’re where we are.
One example is this

If we even would have tested we’d know the version doesn’t update on new Release. We’d know what we need (readme txt, readme Md, requires or requires at least etc)

But we’re always saying we’ll look into it and we never do. It’s the same throughout the entire project and almost all tasks ever came up.

I’m diverging from the topic, but let’s do things differently this time.

Let’s look at what works. Then, let’s adapt.
No more “we’ll look into it”

So, what do we have?

  1. The readme is NOT read by WP if the plugin is not stored on WP Repo. This means, in dashboard > plugins you cannot see “view details” for any of those plugins, even if they include a readme.txt or MD.
  2. The Directory itself does NOT read the readme or any of its info. It needs to be added all manually when submitting the plugin (version, minimum required, etc etc)
  3. My new integration does not care about readme, and gets it right nonetheless because it gets info from plugin header and Directory API.
  4. WP or CP core does not care about readme at all
  5. The Directory does NOT read the new release version and automagically update the download URL either. It needs to be manually updated, both, I just tested it.

All in all, readme (be it md or txt) can be ditched completely as requirement since it is simply not helping. No one ever sees it, no code ever uses it, and the only way to see/read it is to go to Git.
It is only wasting time of reviewers and developers.

4 Likes