Skip to content

Document a semver / deprecation policy for the public API #873

Description

@tschm

Subcategory: Public API / semver discipline (9→10)

The public surface is clean (two entry points — Portfolio and Data — with _-private internal modules), but there is no documented stability guarantee or deprecation policy telling users what they can rely on across versions.

What to change

  • Add a "Versioning & deprecation policy" section to README.md and/or docs/ that states the semver guarantee for the public Portfolio / Data API and the deprecation process (warning window, removal timeline).

Done when

  • A deprecation-policy section exists and is linked from the docs, defining the stability guarantee for the Portfolio and Data public surface.

Context: PR #870

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions