From 5c53137048f8a9943ce02996cde8263daea116b5 Mon Sep 17 00:00:00 2001 From: Peter Kulko <93188219+PKulkoRaccoonGang@users.noreply.github.com> Date: Wed, 11 Dec 2024 18:39:28 +0200 Subject: [PATCH] docs: add description about Opening PRs for Breaking Changes (#3333) --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 761aa21017..1583346cdb 100644 --- a/README.md +++ b/README.md @@ -463,6 +463,11 @@ perf(pencil): remove graphiteWidth option BREAKING CHANGE: The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reason. ``` +#### Opening Pull Requests for Breaking Changes + +Pull requests that include Breaking Changes must be opened against the `next` branch instead of `release-x.x`. +This ensures that breaking changes are accumulated and released together in the next major version, minimizing disruption for consumers. + ## Treeshaking Paragon is distributed on npm as ES6 modules. This means that webpack can use treeshaking on any Paragon components that a consuming app is not using, resulting in greatly reduced bundle sizes.