新しいパッケージをリリースするには、
package.xml
にリリースノートを書く必要があります。
リリースノートには、直近のリリースと比べて何が変わったのかを明確に記述しなければなりません。
また、たとえばベータ版から安定版に移行したなど
安定性
が変化したときは、同じ安定度のひとつ前のリリースからの変更点も記述しなければなりません。
新機能の概要や、修正されたバグの一覧などを記載することになるでしょう。
単にバグ番号だけを書くのではなく、バグの表題も書いておくことが大切です。
単に番号で示されるよりも、言葉で説明されたほうがそのバグについて思い出しやすいからです。
PEAR のウェブインターフェイスでは、自動的に
"bug #<number>" をリンクにします。
複数名でパッチを修正した場合は、ユーザのハンドルをメッセージに追加することもできます。
例 24-3よいリリースノートの例 Changes since the last stable version 1.2.3:
- Added foo and bar feature
- Blubber is far more efficient
Fixed bugs:
- Removed deprecated cURL option CURLOPT_MUTE (Bug #13489) [ashnazg]
- Changed the license to the New BSD License (Bug #13831) [helgi]
Minor issues:
- Converted package.xml to version 2.0
- Cleaned up code to (mostly) comply with phpcs |
|
