プルリクエストにおける変更ログ
プルリクエストの変更ログエントリは、変更内容の「要約」のようなものです。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スクリプトによって、ドラフトを作成するために使用され、その後、リリースコーディネーターによって編集されます。
あなたのメモは、最終リリースノートの適切な場所に変更を追加するために使用されます。