From e04a62dc5465a847e17618e9c8f7a2f37016fc66 Mon Sep 17 00:00:00 2001 From: Gordon Date: Tue, 21 Sep 2021 15:08:04 +0200 Subject: [PATCH 1/8] docs(doc): add versioning policy to README.md --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 62358d57..93f6d42c 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,21 @@ 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/). + +That means that with a version number x.y.z (major.minor.patch): + +- When releasing critical bug fixes, we make a patch release by changing the z number (ex: 3.6.2 to 3.6.3). +- 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. ## We are hiring From 2ac6afb9812d3191ccc4270dff7760440bb23306 Mon Sep 17 00:00:00 2001 From: Gordon Date: Wed, 22 Sep 2021 10:37:42 +0200 Subject: [PATCH 2/8] docs(doc): add versioning policy --- .../docs/Flutter/basics/versioning_policy.mdx | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 docusaurus/docs/Flutter/basics/versioning_policy.mdx diff --git a/docusaurus/docs/Flutter/basics/versioning_policy.mdx b/docusaurus/docs/Flutter/basics/versioning_policy.mdx new file mode 100644 index 00000000..26ab9541 --- /dev/null +++ b/docusaurus/docs/Flutter/basics/versioning_policy.mdx @@ -0,0 +1,21 @@ +--- +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 critical bug fixes, we make a patch release by changing the z number (ex: 3.6.2 to 3.6.3). +- 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. From a071ee645aa1b0b587face7fdd14b971bf973e37 Mon Sep 17 00:00:00 2001 From: Gordon Date: Wed, 22 Sep 2021 10:39:53 +0200 Subject: [PATCH 3/8] docs(doc): update CONTRIBUTING.md --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3bb5a923..249cdf5e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -177,6 +177,24 @@ 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/). + +That means that with a version number x.y.z (major.minor.patch): + +- When releasing critical bug fixes, we make a patch release by changing the z number (ex: 3.6.2 to 3.6.3). +- 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. + +--- + # Styleguides 💅 ![image](https://user-images.githubusercontent.com/20601437/124241186-d17a8680-db1b-11eb-9a21-3df305674ca9.png) From a7813642de44855ce79797f74001ecdaa4234a00 Mon Sep 17 00:00:00 2001 From: Gordon Date: Wed, 22 Sep 2021 10:41:49 +0200 Subject: [PATCH 4/8] docs(doc): update CONTRIBUTING.md --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 249cdf5e..59c37838 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -189,7 +189,9 @@ That means that with a version number x.y.z (major.minor.patch): 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. +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. From 516fd9160ae8354d3a55cdbf80500dc17ef1d14d Mon Sep 17 00:00:00 2001 From: Gordon Date: Wed, 22 Sep 2021 10:42:21 +0200 Subject: [PATCH 5/8] docs(doc): update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 93f6d42c..d76e5bd9 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,9 @@ That means that with a version number x.y.z (major.minor.patch): 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. +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. From 7db270f5f245819e2467f2648cafc492a8c6939d Mon Sep 17 00:00:00 2001 From: Gordon Date: Wed, 22 Sep 2021 10:51:54 +0200 Subject: [PATCH 6/8] docs(doc): update CONTRIBUTING.md --- CONTRIBUTING.md | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 59c37838..b99a2b3c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -181,19 +181,7 @@ Develop is merged into master after the team performs various automated and QA t 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 critical bug fixes, we make a patch release by changing the z number (ex: 3.6.2 to 3.6.3). -- 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. +See our [versioning policy documentation](https://getstream.io/chat/docs/sdk/flutter/basics/versioning_policy/) for more information. --- From 9f32e4671dde4470cbe122e9d9789a4e8025d603 Mon Sep 17 00:00:00 2001 From: Gordon Date: Wed, 22 Sep 2021 10:52:39 +0200 Subject: [PATCH 7/8] docs(doc): update README.md --- README.md | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/README.md b/README.md index d76e5bd9..061a193d 100644 --- a/README.md +++ b/README.md @@ -66,19 +66,7 @@ We also provide a set of sample apps created using the Stream Flutter SDK at [th 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 critical bug fixes, we make a patch release by changing the z number (ex: 3.6.2 to 3.6.3). -- 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. +See our [versioning policy documentation](https://getstream.io/chat/docs/sdk/flutter/basics/versioning_policy/) for more information. ## We are hiring From dc923769d08c799388a8f75e5d2970f72453ebbd Mon Sep 17 00:00:00 2001 From: Gordon Date: Wed, 22 Sep 2021 11:10:38 +0200 Subject: [PATCH 8/8] docs(doc): update versioning policy --- docusaurus/docs/Flutter/basics/versioning_policy.mdx | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docusaurus/docs/Flutter/basics/versioning_policy.mdx b/docusaurus/docs/Flutter/basics/versioning_policy.mdx index 26ab9541..48f25d66 100644 --- a/docusaurus/docs/Flutter/basics/versioning_policy.mdx +++ b/docusaurus/docs/Flutter/basics/versioning_policy.mdx @@ -7,8 +7,7 @@ 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 critical bug fixes, we make a patch release by changing the z number (ex: 3.6.2 to 3.6.3). +- 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).