docs: add changelog and v1-to-v2 migration guide - #304
Merged
David-patrick-chuks-02 merged 2 commits intoSep 6, 2026
Merged
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.
Summary
Closes #275
CHANGELOG.mdwith anUnreleasedsection and release-link convention;docs/migration/v1-to-v2.mdwith the four-step v2 migration process described by the README;Scope
Documentation only. No runtime code, API behavior, dependencies, configuration, source files, or tests changed.
Verification
README.md,CHANGELOG.md, anddocs/migration/v1-to-v2.md;npx prettier --check README.md CHANGELOG.md docs/migration/v1-to-v2.md;git diff --check;upstream/mainbaseline so this docs-only patch cannot turn a previously passing check into a failure.At submission time, upstream
mainalready has unrelated failures in lint/build/tests. Those checks are therefore baseline-compared rather than represented as green. This patch adds no source or test changes.Acceptance criteria
CHANGELOG.mdincludesUnreleasedand a release-linking convention.docs/migration/v1-to-v2.mdmirrors the four migration steps from the versioning policy.Bounty
Submission for issue #275 — $100 bounty.