diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 13a5c22c76..c8a727a830 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -20,24 +20,27 @@ If we definitely shouldn't add Release Notes, add only N/A. Or enumerate sections, subsections and all changes. Possible sections: -- Highlights -- Known Issues -- Breaking Changes -- Features -- Fixes +- Highlights // major features +- Known Issues // issues planned to be fixed, with possible workarounds +- Breaking Changes // incompatible changes without deprecation cycle +- Migration Notes // deprecations, removals, minimal version increases, defined behavior changes +- Features // minor features +- Fixes // bug fixes, undefined behavior changes Possible subsections: -- Multiple Platforms -- iOS -- Desktop -- Web -- Android -- Resources -- Gradle Plugin +- Multiple Platforms // any module, 2 or more platform changes +- iOS // any module, iOS-only changes +- Desktop // any module, Desktop-only changes +- Web // any module, Web-only changes +- Android // any module, Android-only changes +- Resources // specific module, prefer it over the platform ones +- Gradle Plugin // specific module, prefer it over the platform ones +- Lifecycle // specific module, prefer it over the platform ones +- Navigation // specific module, prefer it over the platform ones --> ### Section - Subsection - Describe a change for adding it to https://github.com/JetBrains/compose-multiplatform/blob/master/CHANGELOG.md -- _(prerelease fix)_ Fix some bug that introduced in a prerelease version (dev/beta). It will be included in a dev/beta changelog, but excluded from a stable changelog +- _(prerelease fix)_ Fix some bug that introduced in a prerelease version (alpha/beta/rc). It will be included in a alpha/beta/rc changelog, but excluded from a stable changelog ### Section - Subsection - Describe another change if needed diff --git a/tools/changelog.main.kts b/tools/changelog.main.kts index 002942779e..b781a75313 100644 --- a/tools/changelog.main.kts +++ b/tools/changelog.main.kts @@ -60,6 +60,7 @@ val standardSections = listOf( "Highlights", "Known Issues", "Breaking Changes", + "Migration Notes", "Features", "Fixes", )