Policies
========

Version policy
--------------

The package uses semantic versioning to decide of its deprecation policy, scripts back-compatibility and version numbering.

A release is formatted: ``MAJOR.MINOR.PATCH``

Scripts breaking changes **must** only occur in **major** relases.
They must be documented in the doc-strings and announced whenever they are first thought of, but only enforced in a **major** release.

**Minor** releases will introduce new features, and deprecations.

**Patch** releases must only consist of internal, package API changes and bug fixes.
Any change that don't introduce a change in the scripts API or behaviour.

.. note::

    Behavioural changes may be made on minor or patches if the previous behaviour was clearly not intended
    (for example a fringe case in an algorithmic result not conforming with its implementation reference)