Skip to content

Understand Matfree's API policy

Matfree is a research project, and parts of its API may change frequently and without warning.

This stage of development aligns with its current (0.y.z) version. To quote from semantic versioning:

Major version zero (0.y.z) is for initial development. Anything MAY change at any time. The public API SHOULD NOT be considered stable.

Matfree does not implement an official deprecation policy (just yet) but handles all API change communication via version increments:

  • If a change is backwards compatible (e.g., a backwards-compatible new feature or a bugfix), the patch version is incremented, e.g., from v0.1.5 to v0.1.6.
  • If a change is not backwards compatible, the minor version is incremented, e.g., from v0.1.6 to v0.2.0.