docs: add CHANGELOG with retrospective release notes#21
Open
docs: add CHANGELOG with retrospective release notes#21
Conversation
Document all notable changes across releases using Keep a Changelog format, built from git history.
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
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
Adds a
CHANGELOG.mddocumenting all notable changes across the project's release history, built retrospectively from git history.Format
Uses Keep a Changelog format with sections for Added, Fixed, and Changed. Each version links to the GitHub comparison view.
Coverage
--timeoutflag, CI setup, perf improvementsGoing forward
New releases should add entries under
[Unreleased]during development, then move them to a versioned section at release time. The comparison links at the bottom of the file should be updated when tagging a new version.Test plan