From 7ff27fda261f4fb6d5394de3909b60f872f0e7e6 Mon Sep 17 00:00:00 2001 From: Brian Smith <112954497+brian-smith-tcril@users.noreply.github.com> Date: Wed, 11 Dec 2024 18:07:59 -0500 Subject: [PATCH 1/2] docs: document where to target PRs in a table in the README --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 1583346cdb..df09686d82 100644 --- a/README.md +++ b/README.md @@ -123,6 +123,14 @@ Note that if you are using ``@edx/frontend-platform``'s ``AppProvider`` componen ## Contributing +The branch to target with your PR depends on the type of change you are contributing to Paragon. + +| Branch to Target | Type of Change | Documentation Site | +| - | - | - | +| [`release-22.x`](https://github.com/openedx/paragon/tree/release-22.x) | Bug fix/security patch | https://paragon-openedx-v22.netlify.app/ | +| [`release-23.x`](https://github.com/openedx/paragon/tree/release-23.x) | Bug fix/security patch/new (non-breaking) feature | https://paragon-openedx-v23.netlify.app/ | +| [`next`](https://github.com/openedx/paragon/tree/next) | Breaking change | https://paragon-openedx.netlify.app/ | + Please refer to the ["How to Contribute"](https://openedx.org/r/how-to-contribute) documentation and [Code of Conduct](https://openedx.org/code-of-conduct/) from Open edX. The Paragon Working Group accepts bug fixes, new features, documentation, and security patches. You may find open issues [here](https://github.com/openedx/paragon/issues) or by visiting the Paragon Working Group [project board](https://github.com/orgs/openedx/projects/43/views/15). From e11e7cf043f58e9fed5ffe1d603b5c1287b45f15 Mon Sep 17 00:00:00 2001 From: Brian Smith <112954497+brian-smith-tcril@users.noreply.github.com> Date: Thu, 12 Dec 2024 10:04:03 -0500 Subject: [PATCH 2/2] docs: remove redundant breaking change information --- README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/README.md b/README.md index df09686d82..04bda87aca 100644 --- a/README.md +++ b/README.md @@ -471,11 +471,6 @@ 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.