search

XSAM / otelsql

OpenTelemetry instrumentation for database/sql
Apache License 2.0
314 stars 51 forks source link

Usage of Semantic Versioning #194

Open aryanmehrotra opened 1 year ago

aryanmehrotra commented 1 year ago

Problem Statement

Breaking changes without proper versioning

Proposed Solution

Usage of Semantic Versioning as mentioned in https://semver.org/

Additional Context

If sem ver is used, dependabots and other tools will not automatically try to update this, if sem ver is followed it becomes evident from the release version itself if it might break things.

Also, breaking thing reduces usability

XSAM commented 1 year ago

Could you please state more specific details about the proposal for proper versioning?

Major version zero (0.y.z) is for initial development. Anything MAY change at any time. The public API SHOULD NOT be considered stable.

A repo with major version zero should be okay with the breaking changes without changing the major version.