Browse Source

Describe performance changes in Release Notes section descriptions (#5255)

Treat it as a feature rather than a fix.

Example of a performance improvement:
https://github.com/JetBrains/compose-multiplatform-core/pull/1863

Alternative A - treat it as a fix, not a feature:
```
- Highlights           # major features, performance improvements
- Features             # minor features
- Fixes                # bug fixes, undefined behavior changes, performance improvements
```

Alternative B - refer Fixes in Highlights:
```
- Highlights           # major features and fixes
- Features             # minor features
- Fixes                # bug fixes, undefined behavior changes, performance improvements
```
## Release Notes
N/A
pull/5260/head v1.8.0+dev2171
Igor Demin 10 months ago committed by GitHub
parent
commit
118bdd2504
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 4
      tools/changelog/PR_FORMAT.md

4
tools/changelog/PR_FORMAT.md

@ -52,11 +52,11 @@ Will be includede in alpha/beta/rc changelog, excluded from stable. @@ -52,11 +52,11 @@ Will be includede in alpha/beta/rc changelog, excluded from stable.
### Sections
<!-- This is parsed by changelog.main.kts -->
```
- Highlights # major features
- Highlights # major features, performance improvements
- 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
- Features # minor features, performance improvements
- Fixes # bug fixes, undefined behavior changes
```

Loading…
Cancel
Save