内容

0.14 → 0.15の変更について、keep a changelog形式のchangelogを手書きします。

0.14を使っていたユーザーが0.15に移るとき、知りたいのはどこが変わったかということだと思います。それを手書きのchangelogに書きます。

生成されたWhat's Changedでは不十分だと考えます。例えば0.15.0-preview.16のですが、このようなPR一覧を見てAPIの変更について知るのは困難だと思います。0.15での主な変更点としてはstruct/class Synthesizerと、VVMと、async APIだと思うのですが、それがどこで実装されたかというと#370で、数百個あるPRからそこに辿り着いた上で把握するのは無理かと。

PRの一覧で済ませるOSSも多いですが、それでも例えばRust Analyzer（きっちり7日に一度リリース）のchangelogのように、"New features"と"Fixes"と"Internal Improvements"に分けた上でスクショを添えるといった工夫だけでも加えるところもあります。

Pros 良くなる点

ユーザーが変更箇所をすみやかに把握できるようになる

Cons 悪くなる点

手間

実現方法

書く。

リポジトリの/CHANGELOD.mdに置いておいて、リリース時に転記というのがよいと思います。

VOICEVOXのバージョン

0.15

OSの種類/ディストリ/バージョン

• Windows
• macOS
• Linux

その他

Pydanticのやつのようなマイグレーションガイドも用意できるとよさそう。