Skip to content

docs: align the commit guide with the 1.x version policy - #145

Open
xillig wants to merge 1 commit into
OpenTabular:mainfrom
xillig:docs/conventional-commits-1x
Open

xillig wants to merge 1 commit into
OpenTabular:mainfrom
xillig:docs/conventional-commits-1x

Conversation

@xillig

@xillig xillig commented Nov 11, 2026

Copy link
Copy Markdown

Summary

CONVENTIONAL_COMMITS.md still described the 0.x series: it stated major_version_zero = true and that a breaking change bumps the minor version. pyproject.toml sets major_version_zero = false and the contributing guide documents a major bump, so the two guides disagreed.

  • The bump table, the note and the examples use 1.x versions.
  • The scope list drops temporal and utils, which name code that no longer exists, and adds scopes used in recent history (placement, cross-fitting, search, serialization, logging).

Docs-only change. I am happy to drop the scope-list part if you prefer to keep that list as it is.

Validation

Checks: full suite (2544 passed, 59 skipped, 7 xfailed, coverage >= 94.79%), ruff format / ruff check, pyright (no new diagnostics), docs build with -W, scripts/quickstart.py. Merges cleanly with main and with #136.

CONVENTIONAL_COMMITS.md still described the 0.x series: it stated
major_version_zero = true and that a breaking change bumps the minor
version. pyproject.toml sets major_version_zero = false and the
contributing guide documents a major bump, so the two guides disagreed.

The bump table, the note and the examples now use 1.x versions. The
scope list drops `temporal` and `utils`, which name code that no longer
exists, and adds the scopes used in recent history (placement,
cross-fitting, search, serialization, logging).

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant