@narmi/design_system 1.31.0 → 2.0.0-beta.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -99,6 +99,12 @@ This project uses [`semantic-release`](https://semantic-release.gitbook.io/seman
99
99
  Any time new commits are added to the `master` branch, the GitHub Action "release" will run `semantic-release`. The job will
100
100
  parse recent git tags and commit messages to determine the new version number, tag the release, publish to NPM, and update the changelog.
101
101
 
102
+ #### Major releases
103
+ All PRs target `master` unless it contains breaking changes. Any branch continaing breaking change commits should target the open major release branch.
104
+ For example, if NDS is on major version `1`, breaking changes should target the branch `major/v2`.
105
+
106
+ Branches containing breaking change commits should follow the naming convention `breaking/<branch name>`.
107
+
102
108
  ### Commit Guidelines
103
109
  This project requires structured commit messages in the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format:
104
110