プルリクエストの変更履歴
プルリクエストの変更ログエントリは、変更の「tl;dr:」のような役割を果たします。たとえば、Android に影響するかどうか、破壊的変更か、新しいものが追加されているかなどです。
標準化された形式で変更ログを提供することは、リリースコーディネーターがリリースノートを作成するのに役立ちます。プルリクエストの説明の一部として変更ログを含めてください。プルリクエストがマージされた場合、プルリクエストの説明はコミットメッセージとして使用されます。
フォーマット
変更ログエントリは以下のフォーマットに従います
## Changelog:
[Category] [Type] - Message
「カテゴリ」フィールドは以下のいずれかです
- Android, Android に影響する変更の場合。
- iOS, iOS に影響する変更の場合。
- General, 他のどのカテゴリにも当てはまらない変更の場合。
- Internal, リリースノートを利用する開発者には関係のない変更の場合。
「タイプ」フィールドは以下のいずれかです
- Breaking, 破壊的変更の場合。
- Added, 新機能の場合。
- Changed, 既存機能の変更の場合。
- Deprecated, 間もなく削除される機能の場合。
- Removed, 削除された機能の場合。
- Fixed, バグ修正の場合。
- Security, 脆弱性の場合。
最後に、「メッセージ」フィールドは、機能レベルで「何が、なぜ」を説明します。これを使用して、React Native ユーザーに注目すべき変更を簡潔に伝えます。
詳細については、良い変更ログを作成するには？と変更ログを保持する理由？を参照してください。
サンプル
[General] [Added] - ScrollView コンポーネントに snapToOffsets プロパティを追加[General] [Fixed] - ScrollView コンポーネントの snapToInterval における様々な問題を修正[iOS] [Fixed] - RCTImagePicker のクラッシュを修正
FAQ
プルリクエストが Android と JavaScript の両方に変更を含む場合はどうすればよいですか？
Android カテゴリを使用してください。
プルリクエストが Android と iOS の両方に変更を含む場合はどうすればよいですか？
単一のプルリクエストで変更が行われた場合は、General カテゴリを使用してください。
プルリクエストが Android、iOS、および JavaScript のすべてに変更を含む場合はどうすればよいですか？
単一のプルリクエストで変更が行われた場合は、General カテゴリを使用してください。
もしも…?
変更ログエントリがないよりは、どのようなものでも良いです。適切なカテゴリを選択したかどうかわからない場合は、「メッセージ」フィールドを使用して変更を簡潔に説明してください。
これらのエントリは、@rnx-kit/rn-changelog-generator スクリプトによって下書きが作成され、その後、リリースコーディネーターによって編集されます。
あなたのメモは、最終的なリリースノートの正しい場所にあなたの変更を追加するために使用されます。