Update Pull Request Template #1271
Conversation
|
@MatkovIvan, could you please review? After we agree, I will ask others about this format |
|
@m-sasha, could you also look at the template before I'll post a broader discussion with the team? |
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| - | ||
| - | ||
| - | ||
| [Optional] RelNote [Section/Subsection] Adds a feature |
There was a problem hiding this comment.
@m-sasha, in your new PR we have RelNote/Issues fixed as sections.
Will it be okay if they will be just lines as in this template? If not, let's discuss
There was a problem hiding this comment.
Let's use single-line then.
It was chosen because it is compact, and it is nearby "Fixes" which will be used if no RelNote provided
There was a problem hiding this comment.
We can have issues if we need to write large release notes. But let's start with the current option and change later if needed.
There was a problem hiding this comment.
After looking at the final variant, it may be controversial 😅.
@m-sasha, @MatkovIvan, what do you prefer more?
| 1 | 2 | 3 |
|---|---|---|
 |
 |
 |
There was a problem hiding this comment.
I wouldn't lead with the relnote, so I prefer 1 or 2
There was a problem hiding this comment.
I prefer 2. And maybe we call it "Release Notes"?
There was a problem hiding this comment.
Added as a section, fully reformatted
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| - Breaking changes | ||
| - Features | ||
| - Fixes | ||
| - Prerelease fixes |
There was a problem hiding this comment.
What's the difference between prerelease fixes and regular fixes? Is the distinction important?
There was a problem hiding this comment.
Prelease fixes are fixes of the bugs that we introduced in previous dev/beta release (as a regression, or in a new feature).
We'll include them in the next beta changelog, but won't include in the stable changelog.
I am not sure about adding a separate category for this. What do you think?
There is an option to keep only "Fixes", but add a separate indicator:
prerelease fix - add it if it fixes a bug introduced in a previous prerelease version (dev/beta). It will be excluded from the stable changelog
> Section - Subsection, prerelease fix
- Describe a change for adding it to https://github.com/JetBrains/compose-multiplatform/blob/master/CHANGELOG.md
There was a problem hiding this comment.
Or:
prerelease fix - add it if it fixes a bug introduced in a previous prerelease version (dev/beta). It will be excluded from the stable changelog
> Section - Subsection
- _(prerelease fix)_ Describe a change for adding it to https://github.com/JetBrains/compose-multiplatform/blob/master/CHANGELOG.md
As we did in https://github.com/JetBrains/compose-multiplatform/releases/tag/v1.6.0-beta02
There was a problem hiding this comment.
Okay, I decided to keep it for now, but added a comment
There was a problem hiding this comment.
Let's keep - _(prerelease fix)_ mark for now - separate category takes too much space
| > Prerelease fixes are fixes of bugs introduced in a previous prerelease version (dev/beta). It will be excluded from the stable changelog | ||
|
|
||
| Subsections: | ||
| - Multiple Platforms |
There was a problem hiding this comment.
So if a fix was for k/native and k/js,k/wasm. Do we choose "Multiple Platforms", despite the fix is not applicable for desktop?
Another note:
"Resources" and "Gradle Plugin" is a bit different category than platforms. They are rather "components".
Fixes in "Resources" and "Gradle plugin" can be platform specific as well.
But for simplicity we can keep it like you propose here. If it's not enough, we can add one more "category" later.
There was a problem hiding this comment.
Do we choose "Multiple Platforms", despite the fix is not applicable for desktop?
Yes, it is to avoid adding an additional dimension - it can complicate things.
They are rather "components".
Fixes in "Resources" and "Gradle plugin" can be platform specific as well.
It is more about subsystems rather than targets and components.
We treat "Multiple Platforms", "Desktop", "Web", "iOS" as "Compose. Multiple Platforms", "Compose. Desktop", ... But we omit "Compose" as it is the main changelog for it.
|
Failing web tests can be either ignored, or jb-main can be merged here (or rebased) |
|
The main repo template: JetBrains/compose-multiplatform#4698 |
Introduce the same template used in [core repo](JetBrains/compose-multiplatform-core#1271) (except the CLA section)
Testingin more detailRelease Notesfor the changelog automation.The same template will be in the main repo and in Skiko (except the CLA section)