Skip to content

Publishing Checklist

Use this checklist before creating the public GitHub repository.

Repository hygiene

  • Review README.md for clarity and first impression
  • Confirm LICENSE is correct
  • Confirm CHANGELOG.md exists
  • Confirm .gitignore excludes local caches and generated files
  • Confirm documentation links are up to date

Technical verification

  • Run pnpm install
  • Run pnpm build
  • Run pnpm lint
  • Run pnpm test
  • Run pnpm docs:build
  • Run pnpm smoke:publish
  • Run pnpm specra-lang check examples/imports-app
  • Run pnpm specra-lang refresh examples/imports-app
  • Run pnpm specra-lang proof examples/imports-app
  • Run pnpm specra-lang verify examples/imports-app --results tests/fixtures/observed-results.json
  • Run pnpm --filter specra pack

Open source readiness

  • Add a repository description
  • Add topics such as dsl, ai, verification, typescript, nx
  • Decide whether GitHub Discussions should be enabled
  • Create initial labels such as bug, enhancement, docs, language, verifier
  • Verify GitHub Actions are enabled for the repository
  • Verify the CI, Versioning, and Docs workflows succeed

Contract-driven AI coding and verification.