docs: add a simple CHANGELOG.md that references GH releases
#419
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
- we have release notes already in GH releases, so add a simple `CHANGELOG.md` that references it - I use something similar in most of my libraries - this should hopefully make it easier for users to find the release notes in case they hadn't seen them on GH before
agilgur5
added
scope: docs
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.
Summary
Add a
CHANGELOG.mdthat references the release notes on GH ReleasesDetails
we have release notes already in GH releases, so add a simple
CHANGELOG.mdthat references itthis should hopefully make it easier for users to find the release notes in case they hadn't seen them on GH before