From e8437e6fbb9012798e2c22dd22c70189d4a6e2c5 Mon Sep 17 00:00:00 2001 From: Cory LaViska Date: Thu, 23 Jul 2020 06:47:12 -0400 Subject: [PATCH] Update versioning info --- CONTRIBUTING.md | 4 ++-- docs/getting-started/roadmap.md | 6 ++++++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f771e0ad..085b3353 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -62,9 +62,9 @@ In order to keep the project in a maintainable state, code that doesn't follow c ### Semantic Versioning -This project follows [Semantic Versioning](https://semver.org/). Breaking changes in stable components will not be accepted until the next major version. As such, all contributions must consider the project's roadmap and take this into consideration. Features that are deemed no longer necessary in future versions will be deprecated instead. +Shoelace follows [Semantic Versioning](https://semver.org/). Breaking changes in components with the "Stable" badge will not be accepted until the next major version. As such, all contributions must consider the project's roadmap and take this into consideration. Features that are deemed no longer necessary will be deprecated but not removed. -**Components marked "experimental" should not be used in production,** as changes to them will not be subject to this rule. +Components with the "Experimental" badge should not be used in production. They are made available as release candidates for development and testing purposes. As such, changes to experimental components will not be subject to semantic versioning. ### Code Formatting & Linting diff --git a/docs/getting-started/roadmap.md b/docs/getting-started/roadmap.md index e9db1c88..ad94154e 100644 --- a/docs/getting-started/roadmap.md +++ b/docs/getting-started/roadmap.md @@ -2,6 +2,12 @@ The roadmap tracks the status of components and features that are planned for development. +## Versioning + +Shoelace follows [Semantic Versioning](https://semver.org/). Breaking changes in components with the Stable badge will not be accepted until the next major version. As such, all contributions must consider the project's roadmap and take this into consideration. Features that are deemed no longer necessary will be deprecated but not removed. + +Components with the Experimental badge should not be used in production. They are made available as release candidates for development and testing purposes. As such, changes to experimental components will not be subject to semantic versioning. + ## 2.1 🤔 Version 2.1 is still in the planning phase. To request a feature, please [submit an issue](https://github.com/shoelace-style/shoelace/issues) on GitHub. Make sure to search for existing issues and vote using 👍 to add your support!