Skip to content

Introduce versioning and deprecation policy #470

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

Closed
sliverc opened this issue Aug 31, 2018 · 0 comments
Closed

Introduce versioning and deprecation policy #470

sliverc opened this issue Aug 31, 2018 · 0 comments

Comments

@sliverc
Copy link
Member

sliverc commented Aug 31, 2018

Currently this is not documented so it is not clear what versioning and deprecation policy DJA follows.

This needs to be documented. I would suggest we follow common standards, using Semver and implement a similar deprecation policy like Ember (which is most likely the most used JS framework with JSON API spec).

This way we have a simple migration guide for our users. We can simply say, upgrade to the latest minor version of a series (e.g. 2.6.0) and solve all deprecation warnings. In version 3.0.0 we simply remove all deprecation warnings and do nothing else (real changes follow then in a version 3.1.0 etc.).

Related to #467 #469

sliverc pushed a commit to sliverc/django-rest-framework-json-api that referenced this issue Sep 10, 2018
Fixes django-json-api#470

Includes documentation of versioning and deprecation policy
n2ygk pushed a commit that referenced this issue Sep 11, 2018
* Move to keep a changelog format

Fixes #470

Includes documentation of versioning and deprecation policy

* Remove deprecation warning for JSONAPI prefix

We will remove this before new version will be released.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant