Code Styling Project

Seit wenigen Tagen bietet das Plugin Verzeichnis auf WordPress.org nun die Möglichkeit, direkt anzugeben, welche Änderungen eine neue Version des Plugins enthält. Ich persönlich hatte diese bisher immer unter dem Menüpunkt “other notes” bereitgestellt. Dies jedoch jetzt an eindeutiger Stelle machen zu können, ist sehr vorteilhaft.
Ich möchte mit ein paar Sätzen dazu erklären, was das bedeutet und welchen Nutzen der Anwender von Plugins daraus ziehen kann. Und auch für Plugin-Entwickler habe ich ein paar Worte zu verlieren.

Was heißt oder meint “changelog” eigentlich?

In der professionellen Entwicklung von Software gibt es mit jeder neuen Version eine Übersicht, welche Änderungen in der neuen Version vorgenommen wurden, ob sich Verhaltensänderungen in der Software ergeben haben bzw. welche bereits bekannten oder gemeldeten Softwarefehler behoben wurden. Ebenso werden auch Informationen aufgeführt, welche neuen Features ein Produkt hinzubekommen hat.

Was nutzt mir diese Übersicht?

Diese Zusammenfassung ist in dem meisten Fällen die Grundlage der Entscheidung, ob ein Benutzer auf die neue Version ein Update durchführt oder nicht. Wenn die Änderungen keine Relevanz für einen Benutzer haben, kann er entscheiden, ob er das Update durchführen will oder nicht. Genauso kann aus den Informationen ersichtlich sein, dass ein Update z.B. eine Sicherheitslücke schließt, dann wäre ein Update von Vorteil. Bei einem zu stark geänderten Verhalten der Software kann der Benutzer ebenfalls entscheiden, bei der bisherigen Version zu bleiben, um zum Beispiel Schulungsaufwand und Kosten zu minimieren.

Wie sieht so was aus und wo finde ich das?

Ich habe mal als Beispiel einen Screenshot meines Plugins WP System Health gemacht, um zu zeigen, wo man dies im Repository finden kann.

Wie man hier sehen kann, hat man von jeder Version die wichtigsten Eckdaten in der Übersicht. Dies vereinfacht deutlich die Entscheidungen für oder gegen ein Update.
Aber auch im Backend bei der Plugin-Installation oder dem Update der Version kann man sich diese Informationen nun ebenfalls vorher ansehen.

Somit muss der Benutzer nicht erst das Update machen und dann schauen, was sich geändert hat, er kann sich im Vorfeld darüber bereits informieren.

mahnende Worte an Plugin Entwickler

Viel zu oft treffe ich auf Plugins, die keinerlei solche Informationen besitzen. Meist versuche ich dann über die Homepage des Entwicklers rauszufinden, was genau geändert wurde. Aber auch da ist in vielen Fällen nix zu holen, man kann die Katze nur im Sack bekommen.
Deshalb rufe ich auch nochmal alle Entwickler auf, sich dieser Verantwortung dem Benutzer gegenüber zu stellen und die paar Zeilen mit in die Beschreibungsdatei readme.txt aufzunehmen. Eure Benutzer werden es euch auf lange Sicht danken und ihr beweißt damit einen professionellen Umgang mit dem, was ihr der Welt bereitstellt.

Es ist ziemlich einfach, dies in der readme.txt zu hinterlegen. Am Beispiel meines o.g. Plugins sieht das zum jetzigen Zeitpunkt etwa so aus:

.......
== Installation ==

1. Uncompress the download package
1. Upload folder including all files and sub directories to the `/wp-content/plugins/` directory.
1. Activate the plugin through the 'Plugins' menu in WordPress
1. Navigate to your Dashboard and enjoy status informations

== Changelog ==

= Version 1.0 =
* initial version (formally hosted at my site)

= Version 1.1 =
* Feature: Database section extended
* Bugfix: Correct value display for WordPress settings

= Version 1.1.1 =
* Bugfix: jQuery Bug #4661 prevents expanding of sections at IE 8 and Safari 4
* Bugfix: missing image attached causes unnecessary 404 request
* Sorting: some values of PHP tab has been moved in sections and got a modified text
* Feature: rewrite of info file to use this new changelog presentation option

== Frequently Asked Questions ==
.....

Ich denke, das ist kein besonders großer Aufwand und kann spielend bereitgestellt werden.

abschließende Gedanken

Wie man merkt, geht auch WordPress langsam in Richtung Professionalisierung und stellt nach und nach auch das bereit, was man als Nutzer erwartet. Wenn auch die vielen Plugin Entwickler mitziehen und sich daran orientieren, wird sich in Zukunft sehr leicht erkennen lassen, welche Plugins gepflegt und gewartet werden und welche nur “Schellschüsse” sind.
Da ich aus der professionellen Entwicklung komme, kann ich diese Neuerung nur begrüssen.