-
-
Notifications
You must be signed in to change notification settings - Fork 31
Open
Description
Summary
We should implement release versioning for this Go package to ensure stability and prevent breaking changes for users relying on this package.
Problem
Currently, users consuming this package may unknowingly encounter breaking changes when pulling the latest version. This can lead to unexpected failures or incompatibilities in their applications. Without formal release versioning, it becomes challenging for users to identify stable versions or revert to previous working versions.
Proposal
- Tag the current stable state of the package as
v1.0.0
. - Set up a process for tagging future releases based on the Semantic Versioning guidelines:
- MAJOR version for incompatible API changes.
- MINOR version for backward-compatible new features.
- PATCH version for backward-compatible bug fixes.
- Update the documentation to include release versioning details and guidelines for users on how to specify a version in their
go.mod
files. - Optionally, configure automated release pipelines to streamline the process.
vanbroup
Metadata
Metadata
Assignees
Labels
No labels