Skip to content

Commit

Permalink
docs: add description about Opening PRs for Breaking Changes (#3333)
Browse files Browse the repository at this point in the history
  • Loading branch information
@PKulkoRaccoonGang
PKulkoRaccoonGang authored Dec 11, 2024
1 parent edacfa6 commit 5c53137
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 5c53137

Please sign in to comment.