以下は、2009年7月21日に書かれた WordPress.org 公式ブログの記事、「Improving your plugin – Changelogs」を訳したものです。本文内のリンク先はすべて英語ページです。
プラグイン作者とユーザーとの間で、新しいバージョンのプラグインにどういった変更があったのかがよりうまく伝わるようにするため、最近変更をいくつか行いました。
私たちは、すべてのソフトウェアにはバージョンごとになにが変わったのか、概要を説明する更新履歴 (changelog) が同梱されているべきだと感じています。そうすることによってユーザーの皆さんが「いつアップグレードをしたら良いのか」、「どれくらいサイト上でのテストが必要なのか」といったことについて、状況を理解した上で判断を下せるからです。
簡単にこれを行い、コミュニケーションの方法をオープンにするため、プラグインの readme.txt ファイルに変更履歴セクションへの対応を追加しました。この変更履歴情報は、プラグインディレクトリのタブメニューに追加されるとともに、皆さんの WordPress の管理画面で新バージョンのプラグインに関する情報を表示するときにも見ることができます。
新しいセクションの形式は以下の通りです。
== Changelog == = 1.0 = * A change since the previous version. * Another change. = 0.5 = * List versions from most recent at top to oldest at bottom.
さらに、Subversion レポジトリへプラグインのファイルをコミットするときに、意味のあるログメッセージを追加することもおすすめしたいと思います。こうすることで、あなたのプラグインの変更点をさらに詳しく調べたい人が、その理由を理解することができるからです (現在のところ、多くのプラグイン作者がコミットコメントを空にしていますが、これでは役に立ちません)。