Skip to content

docs: Keep a Changelog header + README link for CHANGELOG.md - #724

Open
drkemp187 wants to merge 1 commit into
microsoft:mainfrom
drkemp187:docs/add-changelog-143
Open

docs: Keep a Changelog header + README link for CHANGELOG.md#724
drkemp187 wants to merge 1 commit into
microsoft:mainfrom
drkemp187:docs/add-changelog-143

Conversation

@drkemp187

@drkemp187 drkemp187 commented Jul 30, 2026

Copy link
Copy Markdown

Summary

  • Keep existing release-please-generated CHANGELOG.md history intact
  • Add Keep a Changelog / SemVer header + ## [Unreleased] section
  • Link changelog from README for discoverability

Closes #143

Why

Root CHANGELOG already existed (release-please). This PR makes the format explicit for OSSF reviewers and links it from the README without rewriting history.

Test plan

  • Full historical entries preserved
  • Markdown renders
  • README link works

@drkemp187
drkemp187 requested a review from a team July 30, 2026 07:10
Preserve the existing release-please CHANGELOG history. Add Keep a
Changelog / SemVer header, an Unreleased section, and a README link so
OSSF reviewers and contributors can find the changelog easily.

Fixes microsoft#143
@drkemp187
drkemp187 force-pushed the docs/add-changelog-143 branch from ec46dac to 979e0ae Compare July 30, 2026 07:10
@drkemp187 drkemp187 changed the title docs: add Keep a Changelog CHANGELOG.md docs: Keep a Changelog header + README link for CHANGELOG.md Jul 30, 2026
@drkemp187

Copy link
Copy Markdown
Author

@microsoft-github-policy-service agree

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(changelog): add CHANGELOG.md generation

1 participant