diff --git a/README.md b/README.md index 04ccc107..8fc4c23f 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,16 @@ We encourage you to contribute to OpenSauced! Please check out the [Contributing We have a commit utility called [@open-sauced/conventional-commit](https://github.com/open-sauced/conventional-commit) that helps you write your commits in a way that is easy to understand and process by others. +## 🚀 Releases + +We use our own [configuration for semantic-release](https://github.com/open-sauced/release). This allows us to automatically generate changelogs and releases for our projects based on the commit messages. + +The `beta` branch is the default branch. We squash & merge PRs to the `beta` branch. We never commit directly to `main`. + +A merge to `beta` will trigger a beta release. A merge to `main` will trigger a full release. + +Make sure to checkout the beta branch for the latest changes, and follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification when writing commit messages. + ## 🍕 Community Got Questions? Join the conversation in our [Discord](https://discord.gg/U2peSNf23P).