docs: add CHANGELOG.md#1944
Open
zichen0116 wants to merge 1 commit into
Open
Conversation
Add a CHANGELOG.md following Keep a Changelog format. This provides a clear, standardized history of notable changes for the project, making it easier for users and contributors to track what has changed between versions.
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
1 participant
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
This PR adds a CHANGELOG.md file following the Keep a Changelog format to the project.
Changes
Why this matters
A changelog provides a clear, human-readable history of notable changes. While GitHub Releases exist, having a CHANGELOG.md in the repository root is a common convention that helps users quickly understand what changed between versions without navigating to GitHub's Releases page.
Format
The changelog follows Keep a Changelog v1.1.0 with sections:
Checklist