Move to keep a changelog format #474
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes django-json-api#470 Includes documentation of versioning and deprecation policy
n2ygk
requested changes
Sep 10, 2018
There was a problem hiding this comment.
Thanks for this. I like following the keepachangelog pattern.
I have a couple of minor concerns w.r.t. relationship to DRF's style of versioning and whether the change from JsonApi to JSONAPI needs to be listed as deprecated since we added/removed it before there was a release.
CHANGELOG.md
Outdated
| * Replaced binary `drf_example` sqlite3 db with a [fixture](example/fixtures/drf_example.json). See [getting started](docs/getting-started.md#running-the-example-app). | ||
|
|
||
| ### Deprecated | ||
|
|
There was a problem hiding this comment.
I believe we've decided to yank this PR before a release ever happened, so I don't think it needs to be listed as deprecated.
We will remove this before new version will be released.
n2ygk
approved these changes
Sep 11, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #470
Includes documentation of versioning and deprecation policy.
This change will also help to better document deprecation changes like currently proposed in #469