[MINOR] docs: Add CHANGELOG.md and reference it from README#12186
Open
niraj-mx07 wants to merge 2 commits into
Open
[MINOR] docs: Add CHANGELOG.md and reference it from README#12186niraj-mx07 wants to merge 2 commits into
niraj-mx07 wants to merge 2 commits into
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
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.
What changes were proposed in this pull request?
This PR introduces a new
CHANGELOG.mdfile to provide a centralized and structured history of Apache Gravitino releases following the Keep a Changelog format.Additionally, the
README.mdhas been updated with a Changelog section that links users directly to the changelog and the project's GitHub Releases page, making release information easier to discover.Why are the changes needed?
Currently, the repository does not provide a dedicated changelog document that summarizes release history in a single location. Adding a
CHANGELOG.mdimproves documentation by:Fix: N/A
Does this PR introduce any user-facing change?
Yes.
CHANGELOG.mdfile containing the project's release history.README.mdto include a link to the changelog and GitHub Releases.How was this patch tested?
CHANGELOG.mdis rendered correctly on GitHub.README.mdcorrectly navigate toCHANGELOG.mdand the GitHub Releases page.