Skip to main content

Semantic Versioning

This page is the Limen-local versioning contract.

Limen local scope

Use this page to decide the version bump and apply the result to Limen's local version surfaces.

Prerequisites

  • the approved change scope and its public compatibility impact
  • the current package version, changelog, citation metadata, templates, and release state

Limen-local version surfaces:

SurfaceRole
pyproject.tomlcanonical package version for builds and releases
CHANGELOG.mdhuman-readable release history
CITATION.cffcitation version and release date
git tag v<version>release identity expected by scripts/create_release.py
docs and package referencesupdate only when the changed behavior affects documented public surfaces

Local rules

  • MAJOR: incompatible public API, CLI, schema, artifact, or package-contract change.
  • MINOR: new compatible public capability.
  • PATCH: compatible fix, docs correction, package metadata correction, dependency/security refresh, or proof-gate change.
  • Keep pyproject.toml, CITATION.cff, template metadata.limen_version, changelog entry, release tag, and release notes aligned to the same version.
  • Code changes require a version update and changelog entry in the same PR. Update affected public docs there as well.
  • A docs-only PR may remain version-neutral. Change the version only when the operator intends that PR to create a release candidate.

Review notes

Version review records the local-policy category, the files requiring version or changelog updates, and whether the release script reads the intended version from pyproject.toml.