Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: merge 22 -> 23 for docs change #3352

Merged
merged 2 commits into from
Dec 12, 2024
Merged

chore: merge 22 -> 23 for docs change #3352

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e58002f
docs: document where to target PRs in a table in the README (#3344)
brian-smith-tcril Dec 12, 2024
8a828cf
feat: use data uri for card fallback image (#3323)
brian-smith-tcril Dec 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down Expand Up @@ -463,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.
Expand Down
Loading