Skip to content

Create a migration and compatibility policy for public SDK APIs #19

Description

@David-patrick-chuks

Summary

Define the project's stance on semantic versioning, deprecation, and compatibility expectations for external users.

Why this matters

A contributor-friendly SDK needs a clear public contract. Without that, roadmap changes can undermine trust and make releases harder to manage.

Scope

  • Document compatibility expectations for public APIs.
  • Define how breaking changes and deprecations are communicated.
  • Align policy with planned versioned API architecture.
  • Keep the policy practical for a growing SDK.

Acceptance Criteria

  • A compatibility policy document exists in the repo.
  • Versioning and deprecation expectations are clear.
  • Policy aligns with current packaging and API architecture direction.
  • Maintainers can reference it in future issue and release work.

Dependencies

Metadata

Metadata

Assignees

No one assigned

    Labels

    apiAPI design and contract workdocumentationImprovements or additions to documentationgovernanceProject policy and maintenance guidance

    Type

    No type

    Fields

    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