Changelog

The changelog serves as a sort of "tl;dr:" for your changes: do they affect Android? are these breaking changes? is something new being added?

Providing a changelog using a standardized format helps release coordinators write release notes. Please include a changelog as part of your pull request description. Your pull request description will be used as the commit message should the pull request get merged.

Format

A changelog entry has the following format

## Changelog:

[Category] [Type] - Message

The "Category" field may be one of:

• "Android"
• "iOS"
• "JavaScript"
• "General", for changes that do not fit any of the other categories.
• "Internal", for changes that would not be relevant to developers consuming the release notes.

The "Type" field may be one of:

• "Added", for new features.
• "Changed", for changes in existing functionality.
• "Deprecated", for soon-to-be removed features.
• "Removed", for now removed features.
• "Fixed", for any bug fixes.
• "Security", in case of vulnerabilities.

Finally, the "Message" field may answer "what and why" on a feature level. Use this to briefly tell React Native users about notable changes.

For more detail, see How do I make a good changelog? and Why keep a changelog?

Examples

• [General][Added] - Add snapToOffsets prop to ScrollView component
• [General][Fixed] - Fix various issues in snapToInterval on ScrollView component
• [iOS][Fixed] - Fix crash in RCTImagePicker