Skip to content

Add CONTRIBUTING with release runbook and CI overview#129

Merged
frazane merged 1 commit into
mainfrom
ci/phase-6-docs
Jun 6, 2026
Merged

Add CONTRIBUTING with release runbook and CI overview#129
frazane merged 1 commit into
mainfrom
ci/phase-6-docs

Conversation

@frazane

@frazane frazane commented Jun 6, 2026

Copy link
Copy Markdown
Owner

Adds a CONTRIBUTING guide documenting the CI and release setup, so the release process (which until recently had never actually run) is written down rather than living in people's heads.

What changed

  • Development setup: how to install all backends, run the suite per-backend, and run the lint hooks.
  • CI overview: what the test matrix and lint job do, the folded coverage leg, concurrency, and the repo automation (Dependabot, labeler, templates).
  • Release runbook: the one-time Trusted Publisher / environment setup, the bare-tag convention (no v prefix, matching pyproject), the TestPyPI rehearsal, the supported release flow via OIDC, label-driven release notes, and a manual fallback.

Notes

  • Branch protection is described as it actually is (one approving review; CI runs on PRs but no specific checks are pinned as required).
  • Tag convention is bare X.Y.Z going forward; historical v-prefixed tags are left as-is.

@github-actions github-actions Bot added the docs label Jun 6, 2026
@frazane frazane merged commit a7bae5e into main Jun 6, 2026
27 checks passed
@frazane frazane deleted the ci/phase-6-docs branch June 6, 2026 21:03
@frazane frazane added the documentation Improvements or additions to documentation label Jun 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant