-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Update README.md #1716
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Update README.md #1716
Conversation
Added mention of Semantic Versioning to the README.md file. Addresses https://jira.mongodb.org/browse/DRIVERS-3105.
@@ -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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- We produce more libraries than just the drivers from this repository, and there is no reason to list them all here in the "Versioning" section.
- We try to follow semantic versioning, but I don't believe we have never violated it, or guarantee that we will never violate it.
Let's rephrase to something like
The MongoDB Java, Kotlin and Scala drivers follow [semantic versioning](https://semver.org/) for their releases. | |
We generally follow [semantic versioning(https://semver.org/) when releasing. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rishitb-mongodb @stIncMale Note that the ticket says:
This will help foster confidence that we do strictly follow semantic versioning even though it might be obvious from our past releases.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- In that case, let's use the option B suggested in the ticket, specifying 5.6.0 as the "since" version. And say that historically the driver generally followed semantic versioning, but may not always had followed it strictly. I vaguely remember us talking about some changes technically requiring a more severe version change, but deciding not to do that.
1.1. We also should remove all the text from the "Versioning" section of the readme, leaving there only the information about us following semantic versioning. Having that text will only introduce confusion, unless the text is identical to the semantic versioning specification.
1.2. Semantic versioning specification itself has versions, and since the intent is to promise that we'll follow it strictly, we should specify the semantic versioning version and link to it (https://semver.org/spec/v2.0.0.html), instead of vaguely referring to semantic versioning as an idea. DRIVERS-3105 fails to require this, but I don't think is possible to talk about strict strict compliance without specifying the spec version being complied with.
1.3. I guess, we'll have to be much more careful with releases, and carefully read all the rules of the versioning scheme. - The suggestion about not listing all the libraries we produce from this codebase is still relevant.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can safely say that we've been strictly following semantic versioning since at least the 3.0 release.
Added mention of Semantic Versioning to the README.md file. Addresses DRIVERS-3015.