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

Define versioning and upgrade compatibility policies #133

Open
yuryu opened this issue Nov 16, 2020 · 0 comments
Open

Define versioning and upgrade compatibility policies #133

yuryu opened this issue Nov 16, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@yuryu
Copy link
Member

yuryu commented Nov 16, 2020

Is your feature request related to a problem? Please describe.
We don't have any upgrade and compatibility policies, and users have no idea what they can expect.

Describe the solution you'd like
Define a clear versioning and compatibility between versions policy. We need a statement for users, and documentation/guideline for Open Saves developers.

My current expectations are as follows

  • alpha: we make breaking changes between alphas in the same release cycle, and that is expected.
  • beta: we try to avoid breaking changes, but we still would if necessary. Such changes will be clearly marked in release notes.
  • release: we will follow the semantic versioning scheme. major releases break things, minor releases don't.

What users could expect from the compatibility promise:

  • You can upgrade the proto definition without making changes to your code base
  • You can upgrade the server version while keeping all the data
  • You cannot downgrade the server version once upgraded
  • Newer clients are compatible with older servers (maybe limit to one or two minor releases).
  • Older clients are not compatible with newer servers
  • Upgrade should work from any older minor release in the same major release cycle
  • Major upgrade might requires an upgrade to the latest minor release of the previous major release

Do we have anything else?

@yuryu yuryu added the documentation Improvements or additions to documentation label Nov 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant