Skip to content

Docs: composer.json version drop + README migration section #6

@navidkashani

Description

@navidkashani

Context

Surfaced during the pre-merge audit of #4. Cosmetic, bundled for 0.6.1.

Gaps

  1. CHANGELOG 0.6 entry doesn't call out that the composer.json top-level "version" field was removed. That's a deliberate, user-visible change (downstream tooling that greps composer.json for pinned version strings will notice) and deserves one line under Changed.
  2. README has no dedicated "Upgrading from 0.5" section. The old→new use mappings (6 of them) currently live only in the PR description, which disappears from the reader's view the moment they land on the repo homepage.

Proposed content

CHANGELOG.md — under 0.6.0-beta → Changed:

  • Dropped top-level "version" field from composer.json; version is now derived solely from Git tags.

README.md — new "Upgrading from 0.5" section near the install instructions, with the 6 mappings (Format\FormatExceptionMoney\FormatException, Format\AmountMoney\Amount, Format\UnitMoney\Unit, AbzarFormatExceptionFormatException, etc. — cross-ref against the PR body for the full list).

Why 0.6.1, not a 0.6 blocker

No code impact; migration info is reachable via the PR for anyone looking right now. But the README is the durable surface and should carry it.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions