Uploaded image for project: 'Drivers'
  1. Drivers
  2. DRIVERS-3105

Update Readme's to mention Semver

    • Type: Icon: Task Task
    • Resolution: Unresolved
    • Priority: Icon: Minor - P4 Minor - P4
    • None
    • Component/s: Docs
    • None
    • Not Needed

      Summary

      As an outcome of the discussion in the recently documented Memo, we should document that we follow Semantic Versioning (SemVer) for our driver releases. This will help foster confidence that we do strictly follow semantic versioning even though it might be obvious from our past releases. 

      Motivation

      Who is the affected end user?

      All Driver users in the open source ecosystem

      How does this affect the end user?

      Lack of confidence in the versioning

      How likely is it that this problem or use case will occur?

      Very less likely

      If the problem does occur, what are the consequences and how severe are they?

      No severe consequences since we do not have any public policy around support and EOL

      Is this issue urgent?

      No

      Is this ticket required by a downstream team?

      No

      Is this ticket only for tests?

      No

      Acceptance Criteria

      Readme files updated on Github for drivers to include the fact that we follow Semantic Versioning (https://semver.org/) for our releases. The following verbiage should be used for the same depending on the driver releases. 

      A. "The MongoDB <X> driver follows [semantic versioning](https://semver.org/) for its releases." --> Use this if the driver has always followed this through its releases. 

      B. "The MongoDB <X> driver follows [semantic versioning](https://semver.org/) since v X.Y.Z of its releases." --> Use this if the driver has historically not abided by the semver principles but aims to from a specific release. E. g .NET/C# Driver 3.0.0 onwards

            Assignee:
            rishit.bhatia@mongodb.com Rishit Bhatia
            Reporter:
            rishit.bhatia@mongodb.com Rishit Bhatia
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: