docs: replace release_note.md with CHANGELOG.md (Keep a Changelog) - #112
Open
t0kubetsu wants to merge 1 commit into
Open
docs: replace release_note.md with CHANGELOG.md (Keep a Changelog)#112t0kubetsu wants to merge 1 commit into
t0kubetsu wants to merge 1 commit into
Conversation
Migrates all release history from the ad-hoc release_note.md into a CHANGELOG.md following keepachangelog.com/en/1.1.0/ conventions: - ## [Unreleased] header for in-progress changes - ## [version] - YYYY-MM-DD for each release - Sections: Added, Changed, Fixed, Known Limitations - Compare links at the bottom for diff navigation Content fully migrated from three releases: Unreleased, 0.2604.0, 0.2510.0. Closes D4-project#111
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
release_note.mdwithCHANGELOG.mdfollowing the Keep a Changelog 1.1.0 standardProblems with the old format
## Changes,## v0.xxx.0 Features,## New Featurevaried by releaseYYYY-MM-DDdateMigration mapping
## Changes/## Features(new capability)### Added## Bugfix/ fixes### Fixed### Changed### Known LimitationsFile changes
CHANGELOG.md— created, full content migratedrelease_note.md— deletedTest plan
CHANGELOG.mdrenders correctly on GitHub[Unreleased],[0.2604.0],[0.2510.0]) are presentCloses #111