You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Rename `Breaking Changes` to `Migration Notes`
- Add Lifecycle/Navigation. We used them in
[CHANGELOG.md](https://github.com/JetBrains/compose-multiplatform/blob/release/1.8.0-alpha03/CHANGELOG.md),
and have it in the script, but didn't have in the template
- Describe each category
- Use platform categories as general ones. It contradicts with my
comments
[here](#5231 (comment))
and
[here](JetBrains/compose-multiplatform-core#1844 (comment)),
that it was only Compose related. But after thinking, we need some
category for changes that don't fall under Compose or any other existing
one. We can use platform categories (probably only Compose and some
Compose components fall into this category right now)
## Release Notes
N/A
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+16-13Lines changed: 16 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,24 +20,27 @@ If we definitely shouldn't add Release Notes, add only N/A.
20
20
Or enumerate sections, subsections and all changes.
21
21
22
22
Possible sections:
23
-
- Highlights
24
-
- Known Issues
25
-
- Breaking Changes
26
-
- Features
27
-
- Fixes
23
+
- Highlights // major features
24
+
- Known Issues // issues planned to be fixed, with possible workarounds
25
+
- Breaking Changes // incompatible changes without deprecation cycle
26
+
- Migration Notes // deprecations, removals, minimal version increases, defined behavior changes
27
+
- Features // minor features
28
+
- Fixes // bug fixes, undefined behavior changes
28
29
29
30
Possible subsections:
30
-
- Multiple Platforms
31
-
- iOS
32
-
- Desktop
33
-
- Web
34
-
- Android
35
-
- Resources
36
-
- Gradle Plugin
31
+
- Multiple Platforms // any module, 2 or more platform changes
32
+
- iOS // any module, iOS-only changes
33
+
- Desktop // any module, Desktop-only changes
34
+
- Web // any module, Web-only changes
35
+
- Android // any module, Android-only changes
36
+
- Resources // specific module, prefer it over the platform ones
37
+
- Gradle Plugin // specific module, prefer it over the platform ones
38
+
- Lifecycle // specific module, prefer it over the platform ones
39
+
- Navigation // specific module, prefer it over the platform ones
37
40
-->
38
41
### Section - Subsection
39
42
- Describe a change for adding it to https://github.com/JetBrains/compose-multiplatform/blob/master/CHANGELOG.md
40
-
-_(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
43
+
-_(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
0 commit comments