メインコンテンツまでスキップ

バージョニングポリシー

概要​

ts-graphviz は、一貫性と予測可能性を確保するためにセマンティックバージョニング 2.0に従っています。 このポリシーは、特にランタイムサポートに関連する破壊的変更の管理方法と、ts-graphviz を使用する際にユーザーが期待できることを明確にします。

セマンティックバージョニング​

バージョン番号は MAJOR.MINOR.PATCH の形式で表され、変更は以下のように分類されます：

  • MAJOR: 後方互換性のない変更を導入します。
  • MINOR: 後方互換性を保ったまま機能を追加します。
  • PATCH: 後方互換性を保ったままバグを修正します。

例外: TypeScriptのバージョンアップデート​

ts-graphviz が厳密なセマンティックバージョニングから逸脱する場合があります：

  • TypeScript定義: TypeScript自体のマイナーアップデートで破壊的変更が導入された場合や、新しいTypeScriptバージョンでのみ利用可能な機能を採用することで、必要最低限のTypeScriptバージョンが上昇する場合、TypeScript型定義に対する破壊的変更がマイナーバージョン間で発生する可能性があります。
ヒント

TypeScriptプロジェクトでは、アップグレードのタイミングと互換性テストを制御するために、ts-graphviz のマイナーバージョンを固定することを推奨します。

情報共有​

バージョニングおよびサポートポリシーに関する透明なコミュニケーションを約束します：

  • ドキュメントおよびリリースノート: バージョニングポリシーおよびサポートレベルのすべての変更は、公式ドキュメントに記載され、リリースノートで詳細に説明されます。
  • コミュニティへの参加: ユーザーは最新の開発情報を得るために、アップデートを購読したり、リポジトリをフォローしたりすることを推奨します。

マイグレーションサポート​

特に破壊的変更が発生した場合に、ユーザーがバージョン間を移行する際の支援を提供します：

  • マイグレーションガイド: 新しいメジャーバージョンにアップグレードするための手順を概説した包括的なマイグレーションガイドを提供します。
  • コード例: 変更に対応するためのコード適応方法を示す例を含めています。
  • サポートチャネル: ユーザーがマイグレーション中に問題に直面した場合、コミュニティフォーラム、イシュートラッカー、その他のサポートチャネルを通じて支援を求めることができます。