跳转至

Release Checklist

This checklist is for the first public draft release of qos-uqci, intended to be tagged as v0.1.0-draft or a similarly explicit draft release.

Architecture And Scope

  • Confirm that QOS, UQCI, and OpenQASM remain clearly separated.
  • Confirm that UQCI IR remains the canonical source of truth.
  • Confirm that DeviceSpec, CalSet, Manifest, and Bundle remain normative sidecar artifacts.
  • Confirm that no release notes, README text, or documentation page describes OpenQASM as the operating system itself.
  • Confirm that claims about backend support remain limited to runnable mock backends and draft reference behavior.

Packaging And Repository Hygiene

  • Confirm that README.md, CONTRIBUTING.md, LICENSE, and ROADMAP.md are present and current.
  • Confirm that pyproject.toml reflects the published package metadata and supported Python versions.
  • Confirm that generated caches, local coverage files, .DS_Store, and built site output are not included in the release commit.
  • Confirm that top-level duplicate reference files are not shipped when the canonical reference inputs already live under docs/reference/.

Quality Gates

  • Run python -m pip install -e ".[dev]" in a clean environment.
  • Run python -m pytest.
  • Run python -m ruff check src backends tests.
  • Run python -m mypy src backends.
  • Run python -m mkdocs build --strict.

Documentation

  • Confirm that the English and Chinese overview pages both link to all 18 chapters.
  • Confirm that MkDocs navigation matches the actual file structure.
  • Confirm that the release notes and release checklist pages are linked and readable from the docs site.
  • Confirm that README sections for project status, documentation, roadmap, and known limitations are current.

GitHub Readiness

  • Confirm that issue templates, PR template, CODEOWNERS, and dependabot.yml are present.
  • Confirm that GitHub Actions workflows for CI and docs are enabled.
  • Confirm that GitHub Discussions, if used, have appropriate categories.
  • Confirm that branch protection and required checks are configured for the default branch.
  • Confirm that GitHub Pages is configured to deploy from GitHub Actions if the docs site will be published immediately.

Release Metadata

  • Confirm that the release tag uses an explicit draft marker, such as v0.1.0-draft.
  • Confirm that release notes accurately describe the project as a draft specification and reference implementation.
  • Confirm that the changelog entry matches the public release wording.
  • Confirm that any citation or referencing guidance does not imply formal standards ratification.