From 118bdd250457caa3d1973a120162129e741ebe8a Mon Sep 17 00:00:00 2001 From: Igor Demin Date: Fri, 7 Mar 2025 13:52:31 +0100 Subject: [PATCH] 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 --- tools/changelog/PR_FORMAT.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/changelog/PR_FORMAT.md b/tools/changelog/PR_FORMAT.md index 123e99e224..1ee381feff 100644 --- a/tools/changelog/PR_FORMAT.md +++ b/tools/changelog/PR_FORMAT.md @@ -52,11 +52,11 @@ Will be includede in alpha/beta/rc changelog, excluded from stable. ### Sections ``` -- 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 ```