Skip to content

Add contributor guidelines on deprecation lifecycle: warning, migration, removalΒ #663

@lochhh

Description

@lochhh

There is currently no documented guidance on how contributors should handle breaking changes, such as API removals, behaviour modifications, or incompatible defaults.

It would be helpful to define a contributor-facing policy that includes minimally:

  • When and how to use warnings, e.g. FutureWarning, DeprecationWarning
  • Minimum deprecation timeline before removal (e.g. N+2 or 3 minor? releases)

Additionally, consider

  • Documentation expectations: changelog entries, migration notes, etc.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    Status

    πŸ€” Triage

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions