Last modified: 4/Oct/2024
How to handle breaking changes
#Step 1: Making the File Changes
When introducing a breaking change with a commit, the related file changes must be made in the directory of the package for which you want to increase the version number.
#Step 2: Formatting the Breaking Change Commit Message
Start the commit message with a brief description of the change with the following format:
feat(packageName)!: commit message
Write the body of the commit message that includes the words BREAKING CHANGE:
followed by a description of the impact of the change on users.
For example:
BREAKING CHANGE: message explaining the breaking change
Your final commit message should look something like this:
feat(dropdown)!: remove a feature BREAKING CHANGE: this commit removes a nice feature
#Step 3: Updating the Stratus Package
Whenever you increase a package's major version, you must also increase the major version of the stratus package
by adding a new line to the file packages/stratus/breaking-changes.md
in the format shown below and repeating the steps
above to commit these changes.
- date - message explaining the breaking change