Open qryxip opened 9 months ago
あった方が良いだろうなと思いました! もう現状の段階のチェンジログを書いてしまってもいいかも?
優先度ですが、must/should/want/canのうちshouldとwantの間くらいかなと思っています。(温度感違ったら教えてください!) そもそもそれぞれの優先度感を策定していませんが、直感的には・・・これのためにリリースタイミングを先送りにすることはないが、スケジュール的に大丈夫なのであれば書き足す、って感じでしょうか。
あ。CI回しておかないと表記ミスりそうな気がしました。
内容
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だと思うのですが、それがどこで実装されたかというとhttps://github.com/VOICEVOX/voicevox_core/pull/370で、数百個あるPRからそこに辿り着いた上で把握するのは無理かと。PRの一覧で済ませるOSSも多いですが、それでも例えばRust Analyzer(きっちり7日に一度リリース)のchangelogのように、"New features"と"Fixes"と"Internal Improvements"に分けた上でスクショを添えるといった工夫だけでも加えるところもあります。
Pros 良くなる点
ユーザーが変更箇所をすみやかに把握できるようになる
Cons 悪くなる点
手間
実現方法
書く。
リポジトリの
/CHANGELOD.md
に置いておいて、リリース時に転記というのがよいと思います。VOICEVOXのバージョン
0.15
OSの種類/ディストリ/バージョン
その他
Pydanticのやつのようなマイグレーションガイドも用意できるとよさそう。