adding a readme.txt file to every wpmudev plugin – usus since 21 July 2009 but missing at WPMUDEV

Hi Developers and WPMUDEV Management

This is a feature request to add to each single WPMUDEV plugin a properly formatted readme.txt with a properly formatted changelog section instead of having a separate changelog.txt file.

https://wordpress.org/news/2009/07/improving-your-plugin-changelogs/

Since July 2009 that is actually usus and state of the art at WordPress but I can’t find readme.txt files in wpmudev plugins.

The point is that the changelog information can not properly read with dates on the WPMUDEV.org website while your staff can actually read it this information gets hidden for members – why?

On the other hand, there are very good plugins and features available which actually should get integrated into one of the wpmudev plugins which manage the plugins (feature request will follow)

read more about it here:

https://westi.wordpress.com/2009/06/20/changelogs-changelogs-changelogs/

and here

https://wordpress.org/news/2009/07/improving-your-plugin-changelogs/

The readme.txt file in the root directory of a plugin which includes the changelog section is since standard in WordPress and it would be nice if WPMUDEV could implement that standard too to all of their plugins.

The standard is summarized here:

https://wordpress.org/plugins/developers/

and a readme.txt file should look like that

https://wordpress.org/plugins/files/2017/03/readme.txt

In section 15 it is described why a properly formatted readme.txt is important

https://developer.wordpress.org/plugins/wordpress-org/detailed-plugin-guidelines/

You can read more about how the readme.txt works in the WordPress Handbook

https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/

You can use the readme.txt generator provided here to generate those files and then move the changelog.txt content over to the readme.txt file.

https://generatewp.com/plugin-readme/

and when finished the readme.txt file should be checked with the readme.txt validator:

https://wordpress.org/plugins/developers/readme-validator/

When those readme.txt files exit in wpmudev plugins as they exist already in other wpmudev plugins the content could also be listed in the backend and there would be no need anymore to click through the web as the newest changes could be read out before even an update would get applied.

i.e. by using the following plugins

https://wordpress.org/plugins/changelogger/

https://me.wordpress.org/plugins/wp-readme-parser/

I hope of the support of many here in the community as it is pretty essential stuff actually to get wpmudev WordPress conform to the WordPress standards.

Looking forward for likes

Andi

  • Nastia
    • Support Rock Star

    Hello Andi

    I trust all is well!

    All our plugins include changelog.txt file that include's the plugin's changelog, plugin's name and developers' names. Also, the changelog is available on every project page (plugin's page) so all the information is public. Please see the attached screenshot

    In case you have located a plugin that doesn't have this file please let us know!

    Have a great day and Merry Christmas!

    Kind regards,

    Nastia

  • Andi
    • The Exporter

    Hi Nastia

    I have to say and assume that you did not read what I wrote and the pages I linked to!

    NO unfortuately the date is missing in all those changelogs while all your staff members incl Ash can see it. ;-( – Your collegue verified already that the date is missing and Ash verified that he can see the date – in other words as members of WPMUDEV we don’t get a proper information and as there is no readme.txt file we cannot even list that information ourself and our customers can not be send to the wpmudev site to check for plugins and their features as they and we don’t see when the last time was a plugin got maintained. as written in ad-widget that was 6 years ago!!! 2011 and inbetween absolut no update and no one applied a very simple solution for a problem by renaming the folder :wink: Which means 6 years were not enough to do that job what I just did in 5 minutes and we could do that even for all those plugins in more or less no time. It would be such as easy!

    So I have to repeat a clear NO and please read the requirements for a proper Plugin development and a proper readme.txt file – check the links above. Thanks!

    Besides that it has to be named readme.txt and in that readme.txt has the changelog to be integrated – check out the Developers Guideline above which I posted and you will see that wpmudev is not following those guidelines since 2009!

    So please get things done and make the change to proper formated readme.txt files like it should be. Unfortunately we can’t help with that due to the missing requirements from your site to do so!

    Kind regards

    Andi

  • Nastia
    • Support Rock Star

    Hello Andi!

    Trust all is well!

    All of our plugins have a changelog.txt file which contains the dates of the version release. Please have a look at attached Hummingbird’s changelog file.

    The chnagelog.txt file layout in our plugins is different from one another because different developers are working on them. And yes, there are few that do not have dates included in the file.

    Nevertheless, I have forwarded your request to our developers.

    Happy Holidays!

    Kind regards

    Nastia

  • Andi
    • The Exporter

    Hi Nastia

    In Germany we would ask “Warum muss WPMUDEV/Incsub eine Extra Wurst haben?”

    WordPress is a Community like WPMUDEV is and actually WPMUDEV is a subcommunity of the WordPress Community and there are Guidlines in place since 2009 which should not be ignored by any WordPress Developer and especially NOT by an organization like WPMUDEV.

    The Guidlines I mentioned are in place for a very good reason as with a readme.txt file and a standard look and formating of those readme.txt files it is possible to cooperate with lots of others in a very professional way.

    Ignoring that like it is the case with WPMUDEV plugins is simply also to show no respect to WordPress at all! And that is not good.

    I have posted one example and we are in process to get all other plugins being with a guideline conform readme.txt too and also for our customers we will rename the stuff to simply show that we use WPMUDEV as a huge block of plugins and additionally we actually want to show our customers that the plugins we use from WPMUDEV get maintained – if not by WPMUDEV since years at least by somebody else or us. Besides that we want to clean up the stuff for 7.2 as I described already as it would give the sites a real speedgain and that is what our customers are looking for.

    We integrate the changelog.txt into the readme.txt where it should be and we add also all the other parts by using the readme.txt generator and everybody can help and contribute actually there to create the readme.txt files for wpmudev plugins to solve those incompatibilities and non-guideline conform problems.

    We hope to have in 2018 also a gitlab private repository so we can better cooperate and contribute.

    We are looking in the future as the slogan of our company is “The future is within us” since 2002

    There are so many great options we discover every day new by simply combining plugins and getting a real good one out and that is the way to go we think. I hope and wish 2018 will get many things done in that way. Merry Christmas!

    Kind regards

    Andi

  • Dimitris
    • Support Star

    Hello there Andi!

    I totally understand the point of having unified readme.txt files with the same format, hopefully our lead developers will take this under consideration and sort this in future updates.

    As for a git repository, I don’t see this happening, at least in near future, as also explained by Bojan here: https://premium.wpmudev.org/forums/topic/we-need-an-accessible-wpmudev-git-for-community-developments#post-1290082

    Warm regards and merry Christmas! :slight_smile: :christmas_tree:

    Dimitris

  • Andi
    • The Exporter

    Hi Dimitris

    The Git repository is not wpmudev it will be ours as we need to get sites up with maintained plugins and not with plugins where people can check the changelog and see that for years nothing has happened, not even changing the required or maximum possible versions.

    So only talking and getting copy paste answers that no ETAs are available doesn’t help when actions are needed.

    So we will start with the plugins we are using step by step and then those which we provide to our customers. we can’t simply wait another year until changes happen so we will start on our own and see how far we come and perhaps the one or other out of the community has ideas how to extend stuff so we can actually do what I thought could happen then on our private git.

    Nevertheless the changelog should be abandoned in favor of proper formatted readme file.

    Merry Christmas

    Andi

Thank NAME, for their help.

Let NAME know exactly why they deserved these points.

Gift a custom amount of points.