Merge pull request #702 from GetStream/docs/versioning-policy

docs(doc): add versioning policy
2021-10-04 13:51:34 +02:00
parent 6553ea4a76 a2a558356e
commit b222a99cfb
3 changed files with 33 additions and 0 deletions
@@ -177,6 +177,14 @@ Develop is merged into master after the team performs various automated and QA t

 ---

+# Versioning Policy
+
+All of the Stream Chat packages follow [semantic versioning (semver)](https://semver.org/).
+
+See our [versioning policy documentation](https://getstream.io/chat/docs/sdk/flutter/basics/versioning_policy/) for more information.
+
+---
+
 # Styleguides 💅

 ![image](https://user-images.githubusercontent.com/20601437/124241186-d17a8680-db1b-11eb-9a21-3df305674ca9.png)
@@ -62,6 +62,11 @@ Every package folder includes a fully functional example with setup instructions

 We also provide a set of sample apps created using the Stream Flutter SDK at [this location](https://github.com/GetStream/flutter-samples).

+## Versioning Policy
+
+All of the Stream Chat packages follow [semantic versioning (semver)](https://semver.org/).
+
+See our [versioning policy documentation](https://getstream.io/chat/docs/sdk/flutter/basics/versioning_policy/) for more information.

 ## We are hiring

@@ -0,0 +1,20 @@
+---
+id: versioning_policy
+sidebar_position: 3
+title: Versioning Policy
+---
+
+All of the Stream Chat packages follow [semantic versioning (semver)](https://semver.org/).
+
+That means that with a version number x.y.z (major.minor.patch):
+- When releasing bug fixes (backwards compatible), we make a patch release by changing the z number (ex: 3.6.2 to 3.6.3). A bug fix is defined as an internal change that fixes incorrect behavior.
+- When releasing new features or non-critical fixes, we make a minor release by changing the y number (ex: 3.6.2 to 3.7.0).
+- When releasing breaking changes (backward incompatible), we make a major release by changing the x number (ex: 3.6.2 to 4.0.0).
+
+See the [semantic versioning](https://dart.dev/tools/pub/versioning#semantic-versions) section from the Dart docs for more information.
+
+This versioning policy does not apply to prerelease packages (below major version of 1). See this
+[StackOverflow thread](https://stackoverflow.com/questions/66201337/how-do-dart-package-versions-work-how-should-i-version-my-flutter-plugins)
+for more information on Dart package versioning.
+
+Whenever possible, we will add deprecation warnings in preparation for future breaking changes.