[](https://github.com/primait/bridge.rs)
# bridge.rs
Prima bridge pattern implementation for rust
[Api documentation](https://docs.rs/prima_bridge)
## Examples
You can find all the examples in [examples](./examples) directory.
## Release Process
This project uses **[release-plz](https://release-plz.dev/)** for versioning and
publishing to crates.io.
Upon push to `master`, the [CD Workflow](./.github/workflows/cd.yml) is
triggered, which:
- creates or updates a release Pull Request using `release-plz release-pr`
- automatically releases any unpublished packages using `release-plz release`
This means that to release a new version, you just need to merge the release PR
created by `release-plz` and the rest of the process will be handled
automatically.
### Conventional Commits
To ensure the correct version bumping, use
[conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) when
squash-merging to `master`. This is not yet enforced by any tool, so it's up to
you to follow the convention.
For breaking changes, it can be useful to include a `BREAKING CHANGE:` section
in the commit body, which will trigger a major version bump. This is especially
important if the breaking change is not obvious from the commit message itself.