Added a changelog #30
Merged
Conversation
This file contains 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
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.
It is very useful to have a changelog, to see what notable changes have been made over time.
For example, It's the first place I check when I want to check if there are any breaking changes in a new version of a library.
Items usually have a link to the issue if available, alternative link to PR or individual commit if relevant...but sometimes no link is fine (especially if it may span multiple PRs/commits).
NOTE: I've omitted some more cosmetic or internal changes that I wouldn't consider exactly "notable" changes. At the end of the day detailed diffs and list of changes can be seen on GitHub, the changelog shouldn't be exhaustive IMHO.
PS: It was a bit tedious to compose this up, it may no be perfect but it's a good start I think. Hopefully should be less of a pain to update this gradually when something changes :)