メインコンテンツへスキップ

プルリクエストの変更履歴

プルリクエストの変更履歴エントリは、変更の「tl;dr:」（要約）のような役割を果たします。変更はAndroidに影響しますか？互換性を破る変更ですか？新しいものが追加されましたか？

標準化された形式で変更履歴を提供することで、リリースコーディネーターはリリースノートを作成しやすくなります。プルリクエストの説明の一部として変更履歴を含めてください。プルリクエストがマージされた場合、プルリクエストの説明がコミットメッセージとして使用されます。

形式​

変更履歴エントリは以下の形式です

## Changelog:

[Category] [Type] - Message

「Category」フィールドは以下のいずれかです。

  • Android、Androidに影響する変更の場合。
  • iOS、iOSに影響する変更の場合。
  • General、他のどのカテゴリにも当てはまらない変更の場合。
  • Internal、リリースノートを参照する開発者にとって関連性のない変更の場合。

「Type」フィールドは以下のいずれかです。

  • Breaking、互換性を破る変更の場合。
  • Added、新機能の場合。
  • Changed、既存の機能の変更の場合。
  • Deprecated、まもなく削除される機能の場合。
  • Removed、すでに削除された機能の場合。
  • Fixed、バグ修正の場合。
  • Security、脆弱性の場合。

最後に、「Message」フィールドは機能レベルで「何が、なぜ」を説明します。これを使用して、React Nativeユーザーに注目すべき変更を簡潔に伝えます。

詳細については、「良い変更履歴を作成するには？」と「変更履歴を維持する理由？」を参照してください。

例​

  • [General] [Added] - ScrollViewコンポーネントにsnapToOffsetsプロパティを追加
  • [General] [Fixed] - ScrollViewコンポーネントのsnapToIntervalに関する様々な問題を修正
  • [iOS] [Fixed] - RCTImagePickerでのクラッシュを修正

FAQ​

プルリクエストにAndroidとJavaScriptの両方への変更が含まれている場合はどうなりますか？​

Androidカテゴリを使用してください。

プルリクエストにAndroidとiOSの両方への変更が含まれている場合はどうなりますか？​

単一のプルリクエストで変更が行われた場合は、Generalカテゴリを使用してください。

プルリクエストにAndroid、iOS、JavaScriptへの変更が含まれている場合はどうなりますか？​

単一のプルリクエストで変更が行われた場合は、Generalカテゴリを使用してください。

もし〜なら？​

変更履歴エントリは何もないよりはましです。適切なカテゴリを選んだかどうか不明な場合は、「message」フィールドを使用して変更内容を簡潔に説明してください。

これらのエントリは、@rnx-kit/rn-changelog-generatorスクリプトによって草案が作成され、その後リリースコーディネーターによって編集されます。

提供されたメモは、最終的なリリースノートの適切な場所にあなたの変更を追加するために使用されます。