Skip to content

v1.0 API stability: freeze public contract and write migration guide #7

Description

@olesme

Goal

Declare a stable 1.0 API surface before incrementing the major version.

Work items

  • Audit all public types across src/Catchy and src/Catchy.SourceGenerator
  • Mark anything not ready for stability with [EditorBrowsable(Never)] or move to Catchy.Sdk
  • Write docs/MIGRATION.md covering 0.x → 1.0 breaking changes
  • Enable PackageValidation (Catchy.ApiCompat or Microsoft.DotNet.ApiCompat) in CI

Non-goals

  • Compatibility shims (CLAUDE.md: no back-compat shims pre-1.0)

Tracking

This issue tracks the 1.0 milestone. Tag all breaking-change PRs with breaking-change.

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

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions