From 7d9c6f1988e2b2aec2bff2e51350e31979b0c0ff Mon Sep 17 00:00:00 2001 From: rishitb-mongodb <160672125+rishitb-mongodb@users.noreply.github.com> Date: Thu, 22 May 2025 16:09:20 -0400 Subject: [PATCH 1/3] Update README.md Added mention of Semantic Versioning to the README.md file. Addresses https://jira.mongodb.org/browse/DRIVERS-3105. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index cc0fe3b913..5cb08a3318 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,8 @@ MongoDB project, please report it according to the [instructions here](https://w ## Versioning +The MongoDB Java, Kotlin and Scala drivers follow [semantic versioning](https://semver.org/) for their releases. + Major increments (such as 4.x -> 5.x) will occur when breaking changes are being made to the public API. All methods and classes removed in a major release will have been deprecated in a prior release of the previous major release branch, and/or otherwise called out in the release notes. From 615d2d58f3e858a3e6de8ab54fbac570260c544e Mon Sep 17 00:00:00 2001 From: rishitb-mongodb <160672125+rishitb-mongodb@users.noreply.github.com> Date: Thu, 5 Jun 2025 17:12:23 -0400 Subject: [PATCH 2/3] Update README.md Updated verbiage based on suggestions and removed older descriptions of versions --- README.md | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/README.md b/README.md index 5cb08a3318..df66cd6069 100644 --- a/README.md +++ b/README.md @@ -42,19 +42,7 @@ MongoDB project, please report it according to the [instructions here](https://w ## Versioning -The MongoDB Java, Kotlin and Scala drivers follow [semantic versioning](https://semver.org/) for their releases. - -Major increments (such as 4.x -> 5.x) will occur when breaking changes are being made to the public API. All methods and -classes removed in a major release will have been deprecated in a prior release of the previous major release branch, and/or otherwise -called out in the release notes. - -Minor 5.x increments (such as 5.1, 5.2, etc) will occur when non-trivial new functionality is added or significant enhancements or bug -fixes occur that may have behavioral changes that may affect some edge cases (such as dependence on behavior resulting from a bug). An -example of an enhancement is a method or class added to support new functionality added to the MongoDB server. Minor releases will -almost always be binary compatible with prior minor releases from the same major release branch, except as noted below. - -Patch 5.x.y increments (such as 5.0.0 -> 5.0.1, 5.1.1 -> 5.1.2, etc) will occur for bug fixes only and will always be binary compatible -with prior patch releases of the same minor release branch. +We generally follow [semantic versioning](https://semver.org/spec/v2.0.0.html) when releasing. #### @Alpha From d9e3630e12c38c6e5ae8b9e37df76f7968a4791a Mon Sep 17 00:00:00 2001 From: rishitb-mongodb <160672125+rishitb-mongodb@users.noreply.github.com> Date: Fri, 6 Jun 2025 16:49:26 -0400 Subject: [PATCH 3/3] Update README.md Removed "generally" based on most recent clarification --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index df66cd6069..fabc2259dd 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ MongoDB project, please report it according to the [instructions here](https://w ## Versioning -We generally follow [semantic versioning](https://semver.org/spec/v2.0.0.html) when releasing. +We follow [semantic versioning](https://semver.org/spec/v2.0.0.html) when releasing. #### @Alpha