-
Notifications
You must be signed in to change notification settings - Fork 5.6k
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
About Compatibility #11528
Comments
drafting a version document for 1.0 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Paddle follows semantic versioning.
Each release has version of the following format:
MAJOR.MINOR.PATCH
. Some key points:Major version zero (0.y.z) is for initial development. Anything may change at any time. The public API should not be considered stable. (We'll discuss it doesn't quite fit us)
For 1.y.z, changes across
MINOR
version should be backward compatible.If your software is being used in production, it should probably already be 1.0.0. If you have a stable API on which users have come to depend, you should be 1.0.0. If you’re worrying a lot about backwards compatibility, you should probably already be 1.0.0.
Why Paddle Needs to Worry About Compatibility Now
Why not release 1.x.y now.
What can be done before 1.x.y
API that you are not sure if user would use it, make it private.
API that is expected to be public but is expected to change:
contrib/
directory.If a backward incompatible change can make the design much better and cleaner
If API has bug that can only be fixed in an incompatible way.
Write a tool to monitor incompatible change
What changes could cause incompatibility.
Reference
https://semver.org/
http://docs.chainer.org/en/stable/compatibility.html
https://www.tensorflow.org/programmers_guide/version_compat
The text was updated successfully, but these errors were encountered: