WordPress.org

Improving your plugin – Changelogs

Posted July 21, 2009 by Peter Westwood. Filed under Documentation.

We’ve recently made some changes to help improve the communication between plugin authors and plugin users about the changes that are made between versions.

We feel that all software should have a changelog that details, at a high level, what changes have been made in each version so that the user can make an informed decision about when to upgrade and how much testing they should do with their site.

In order to make this an easy and open communication channel we have added support for a Changelog section in the plugins readme.txt file.  This changelog information is then displayed as a separate tab in the plugin directory and also in the back end of your WordPress blog when you view the details on a new version of a plugin.

The new section is formatted as follows:

== Changelog ==

= 1.0 =
* A change since the previous version.
* Another change.

= 0.5 =
* List versions from most recent at top to oldest at bottom.

We would also like to recommend that you also provide meaningful log messages when you commit changes to the subversion repository for your plugin so that people who want to dig further into your changes can see why things are changing (At the moment is seems a large number of plugin authors leave this field blank which isn’t very helpful).

19 Pings

RSS feed for comments on this post.

  1. […] the original post:  Improving your plugin – Changelogs Share and […]

    Pingback from Improving your plugin – Changelogs | Lukmanul Hakim.net on July 21, 2009

  2. […] the rest here: Improving your plugin – Changelogs Share and […]

    Pingback from Improving your plugin – Changelogs | Opensource CMS | Just another Opensource News on July 21, 2009

  3. […] 原文:https://wordpress.org/development/2009/07/improving-your-plugin-changelogs/ […]

    Pingback from wordpress开发博客:改进你的插件--更新记录 | WordPress Tea House on July 22, 2009

  4. […] of the change log is fairly simple as shown in the snippet below (taken from the WordPress Blog): == Changelog […]

    Pingback from WordPress Plugin ChangeLog « Nitin Katkam on July 22, 2009

  5. […] Credit: Click here… […]

    Pingback from Improving your plugin – Changelogs | LEHSYS Blogger News on July 22, 2009

  6. […] from here: We feel that all software should have a changelog that details, at a high level, what changes have […]

    Pingback from Rohan Kapoor » Blog Archive » WordPress Changes Guidelines for Plugin Authors! on July 22, 2009

  7. […] Changelogs in WordPress Plugins […]

    Pingback from The importance of using Changelogs | Wp Themes Planet on July 23, 2009

  8. […] 以下は、2009年7月21日に書かれた WordPress.org 公式ブログの記事、「Improving your plugin – Changelogs」を訳したものです。本文内のリンク先はすべて英語ページです。 […]

    Pingback from WordPress | 日本語 » プラグインの改善 – 変更履歴 on July 23, 2009

  9. […] to add a changelog to their plugins, read why adding changelog matters also check out the blog post Improving your plugin – Changelogs from the WordPress development blog. (No Ratings Yet)  Loading …   Tags: […]

    Pingback from Why Should You Add Your Plugin to WordPress Extend? | Weblog Tools Collection on July 24, 2009

  10. […] to add a changelog to their plugins, read why adding changelog matters also check out the blog post Improving your plugin – Changelogs from the WordPress development […]

    Pingback from SEO2Blog » Why Should You Add Your Plugin to WordPress Extend? on July 24, 2009

  11. […] to add a changelog to their plugins, read why adding changelog matters also check out the blog post Improving your plugin – Changelogs from the WordPress development […]

    Pingback from Why Should You Add Your Plugin to WordPress Extend? | Word Press Magazine on July 24, 2009

  12. […] the subject of wordpress, I’m glad to see the addition of changelogs to the plugin directory – being asked to upgrade plugins without any idea what’s changed has long been a […]

    Pingback from a work on process » Talking to WordPress with ActiveRecord on July 24, 2009

  13. Improving your plugin – Changelogs…

    We’ve recently made some changes to help improve the communication between plugin authors and plugin users about the changes that are made between versions.

    We feel that all software should have a changelog that details, at a high level, what changes …

    Trackback from imle.in on July 25, 2009

  14. […] WordPress » Improving your plugin – Changelogs announces that a new section will be added to the readme.txt files that plugin authors should use to track changes.  As a heavy user of plugins across several different websites this is a very nice improvement.  It will make the plugin update that much smoother, as admins will no longer have to go hunting for changes on another website, it will just show up on the plugin upgrade panel.  It is things like this that make the WordPress UI so good and why WordPress is my favourite framework. Hopefully authors will start using it. […]

    Pingback from WordPress – Plugin Changelogs | Jamas.Net on July 31, 2009

  15. […] for WordPress.org Updates? By myWordPress Recently Peter Westwood wrote about a new feature for WordPress plugin authors on wordpress.org, about how to implement better communication between authors and users of the […]

    Pingback from Changelog for WordPress.org Updates? | myWordPress on August 5, 2009

  16. […] Updated readme.txt format (Changelog). […]

    Pingback from Released WP Greet Box 5.3.0 | OMNINOGGIN on August 6, 2009

  17. […] WordPress: improving your plugin – changelogs […]

    Pingback from WordPress Wednesday: 50 Links & Resources from around the web | WordPress Guerrilla on August 19, 2009

  18. […] Source […]

    Pingback from Improving your plugin – Changelogs » blog.if-else.fr on August 27, 2009

  19. […] Source WordPress Development […]

    Pingback from WordPress Hosting | Improving your plugin – Changelogs on September 3, 2009

See Also:

For more WordPress news, check out the WordPress Planet.

There’s also a development P2 blog.

To see how active the project is check out our Trac timeline, it often has 20–30 updates per day.

Categories

%d bloggers like this: