Skip to content

Please publish a stable interface (1.0) and consistent release notes #76

@kurtisvg

Description

@kurtisvg

Is your feature request related to a problem? Please describe.
denisenkom/go-mssqldb has been around for a few years and does not have a 1.0 version. This fork is the successor of that library, and has had several breaking changes. Releases are being tagged (e.g. https://github.com/microsoft/go-mssqldb/tags) which means new versions are rolling out to Go users, but the Releases doesn't have any release notes for these changes.

Relying on and updating to this library is painful - more breaking changes could occur at any time, there's not a good digest of those changes, meaning that it's hard to use this library in it's

Describe the solution you'd like
Two things:

  1. Adopt a consistent release schedule and publish release notes. There's automation that can help such as ReleasePlease that can help make this easier and more streamlined.

  2. Release a 1.0 and stop pushing breaking changes without a major version bump. Add some proper e2e tests of the public API that will alert with the public API has been broken. Signal to users that they can rely on this library and don't need to worry about the API breaking suddenly.

Describe alternatives you've considered
N/A

Additional context
Add any other context or screenshots about the feature request here.

Metadata

Metadata

Labels

Priority: 1High priority/impactv1-candidateNominate PR or Issue for V1 project

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions