Skip to content
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

Release SDK v1.0, guarantee backwards compatibility #469

Closed
mollykarcher opened this issue Mar 9, 2023 · 1 comment · Fixed by #670
Closed

Release SDK v1.0, guarantee backwards compatibility #469

mollykarcher opened this issue Mar 9, 2023 · 1 comment · Fixed by #670

Comments

@mollykarcher
Copy link

mollykarcher commented Mar 9, 2023

What problem does your feature solve?

This SDK version is pre-1.0, which implies that we may break the interface between versions without warning to developers. This means developers can't have total confidence in using it, and may need to make significant changes on their wide when just pulling in minor version bumps. It also disincentivizes our team from caring about maintaining backwards compatibility, which proliferates the problem. This SDK shadows the Horizon API, which is stable and defined a major version, so there isn't really a good reason why we would need to make significant breaking changes repeatedly to this SDK. Breaking changes can happen more frequently than horizon's API but it shouldn't be a free-for-all.

What would you like to see?

An official release on Github of this SDK that versions itself at >= 1.0. Going forward, we properly respect semantic versioning and will not introduce backwards incompatible changes without bumping to a new major version.

It would also be worth it (before officially cutting it) to do a bit of a holistic audit and cleanup here, to make sure we are confident and proud of what we release as 1.0.

What alternatives are there?

@overcat
Copy link
Member

overcat commented Sep 2, 2024

I plan to release the stable version 1.0.0 with the launch of Protocol 22.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants
@mollykarcher @overcat and others