From aac074ab49b44ccea0c9eb12d996f7033c20e3b7 Mon Sep 17 00:00:00 2001
From: Saijad Dhuka <83975678+sdhuka@users.noreply.github.com>
Date: Thu, 24 Aug 2023 15:50:49 -0500
Subject: [PATCH] Update readme & contributing guide to add versioning (#2544)

Co-authored-by: gpanshu <91897496+gpanshu@users.noreply.github.com>
---
 CONTRIBUTING.md | 14 ++++++++++++++
 README.md       | 13 +++++++++++++
 2 files changed, 27 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e01f10209c..db1dfc2fad 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -21,6 +21,7 @@ contribution.
     - [Test changes to CodeBuild build definitions](#test-changes-to-codebuild-build-definitions)
   - [Reporting Bugs/Feature Requests](#reporting-bugsfeature-requests)
   - [Contributing via Pull Requests](#contributing-via-pull-requests)
+    - [Semantic Versioning](#semantic-versioning) 	
   - [Troubleshooting](#troubleshooting)
     - [Environment Debugging](#environment-debugging)
     - [Problems with the Build](#problems-with-the-build)
@@ -455,6 +456,19 @@ will run all build tasks (Checkstyle, Lint, unit tests).
 - Make sure to update the PR title/description if things change.
 - Rebase with the `main` branch if it has commits ahead of your fork.
 
+### Semantic versioning
+
+We follow [semantic versioning](https://semver.org/) for our releases.
+
+#### Semantic versioning and enumeration cases
+
+When Amplify adds a new a new enumeration class entry or sealed class subtype, we
+will publish a new **minor** version of the library.
+
+Applications that use a `when` expression to evaluate all members of an enumerated
+type can add an `else` branch to prevent new cases from causing compile warnings
+ or errors.
+
 ## Troubleshooting
 
 ### Environment Debugging
diff --git a/README.md b/README.md
index 977b78dd8e..fbf33096d3 100644
--- a/README.md
+++ b/README.md
@@ -112,6 +112,19 @@ Amplify's default interface renders results through async callbacks. We also pro
  - [Using RxJava with Amplify](https://docs.amplify.aws/lib/project-setup/rxjava/q/platform/android)
  - [Kotlin Coroutines Support](https://docs.amplify.aws/lib/project-setup/coroutines/q/platform/android)
 
+### Semantic versioning
+
+We follow [semantic versioning](https://semver.org/) for our releases.
+
+#### Semantic versioning and enumeration cases
+
+When Amplify adds a new a new enumeration class entry or sealed class subtype, we
+will publish a new **minor** version of the library.
+
+Applications that use a `when` expression to evaluate all members of an enumerated
+type can add an `else` branch to prevent new cases from causing compile warnings
+ or errors.
+
 ## License
 
 This library is licensed under the [Apache 2.0 License](./LICENSE).