Skip to content

[DX] Establish CHANGELOG with migration notes for breaking changes #66

Description

Goal

Every breaking change documented with a Before: / After: snippet.

What to ship

Acceptance criteria

  • CHANGELOG present and current.
  • A pre-merge check or contributor guideline that says "if your PR is breaking, add a CHANGELOG entry."
  • Release notes link to CHANGELOG.

Why

PR #44's default flip would have been less surprising with a CHANGELOG. As the user base grows this becomes essential.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationdxDeveloper experiencetier-3Aspirational / future

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions