From fe16d3e1aa68956e145689571410c69773230ed9 Mon Sep 17 00:00:00 2001 From: Morgan Bentell Date: Thu, 16 Feb 2023 13:19:42 +0100 Subject: [PATCH] Update CONTRIBUTING.md Clarify how semantic versioning should be used. The emphasis was on `0.x` versions, but nowadays most packages are above `1.0` so hopefully this will be less confusing. Signed-off-by: Morgan Bentell --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f3de7bf0e5..e22fbf29a4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -136,7 +136,7 @@ Changesets **are** needed for new packages, as that is what triggers the package 1. Run `yarn changeset` 2. Select which packages you want to include a changeset for -3. Select impact of change that you're introducing, using `minor` for breaking changes and `patch` otherwise. We do not use `major` changes while packages are at version `0.x`. +3. Select impact of the change you're introducing. If the package you are changing is at version `0.x`, use `minor` for breaking changes and `patch` otherwise. If the package is at `1.0.0` or higher, use `major` for breaking changes, `minor` for backwards compatible API changes, and `patch` otherwise. See the [Semantic Versioning specification](https://semver.org/#semantic-versioning-specification-semver) for more details. 4. Explain your changes in the generated changeset. See [examples of well written changesets](https://backstage.io/docs/getting-started/contributors#writing-changesets). 5. Add generated changeset to Git 6. Push the commit with your changeset to the branch associated with your PR