Add a CHANGELOG.md to keep track of changes in the project #385
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
Vkt0r
requested review from
adamkaplan,
damian-kolakowski,
ignatovSA,
julien-c,
marcc-orange,
mbarnach and
pvzig
tomieq
pushed a commit
to tomieq/swifterfork
that referenced
this pull request
Apr 1, 2021
Add a CHANGELOG.md to keep track of changes in the project
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
With a
CHANGELOG.mdwe can keep track of changes in each PR and make the release notes more readable for everyone looking for changes between versions. I took the main concept from https://keepachangelog.com/en/1.0.0/.The expected behavior should add a new entry to the
CHANGELOG.mdin each PR explaining what it brings to the project. I created the version 1.4.6 entry in the currentCHANGELOG.mdas an example. Open to any suggestions and improvements in the words, etc.