Starter template for TypeScript / Effect libraries and tools.
| Surface | Examples | Limit |
|---|---|---|
| Evaluator | commitlint.config.ts, .github/workflows/ |
Read-only; never edit the instrument that grades work. |
| Doctrine | CONSTITUTION.md, subtrees.toml |
Project law; edit only on deliberate direction. |
| Vendored | repos/** |
Read-only; updated via git subtree, never hand-edited. |
| Human approval | Releases, publishing, external credentials | User-confirmed only. |
| Editable | Workspace source, tests, documentation | Edit freely. |
| Doc | Trigger |
|---|---|
CONSTITUTION.md |
architecture changes, rule authoring, or design disputes |
repos/constitution/ENFORCEMENT.md |
building or changing an instrument that grades work (lint gates, stream rules, CI checks, thresholds, rubrics, advisors); situational read only |
| ID | Rule | Gate |
|---|---|---|
START-1 |
Formatting passes dprint with no diffs | pnpm format:check |
START-2 |
Typechecking succeeds workspace-wide with no errors | pnpm typecheck |
START-3 |
All test suites pass | pnpm test |
START-4 |
CI passes on the pushed head; not run locally | CI: pnpm check:ci |
START-5 |
The e2e journeys pass against pnpm dev |
pnpm journeys |
Workspace roots: packages/ holds libraries, apps/ holds publishable
applications — both are workspace globs in pnpm-workspace.yaml. Turbo declares
dist/** as each package's build output; pnpm gate:dist runs that build.
- This repo is a template and holds no credentials; CI proves everything locally. Gate: review of the workflow diff; a job that needs a secret carries
if: ${{ !github.event.repository.is_template }}. - Every job runs on GitHub-hosted
ubuntu-latestrunners. This repository is public, and the org's self-hosted fleet runner group admits only private repositories (fork safety), so a[self-hosted, systemfsoftware-runner, *]job here queues forever. Gate: review of the workflow diff. - Cloudflare credentials enter a sandbox only through
bin/cloud(deploy, destroy, state reads). Gate: review of the workflow diff — wrong:sandbox --pass-env CLOUDFLARE_API_TOKEN -- pnpm --filter @endgame/site exec alchemy deploy; right:./bin/cloud pnpm --filter @endgame/site exec alchemy deploy. - CI is two workflows:
check.yml(onecheckjob:turbo run format:check lint typecheck test --affected(no--affectedon merge-queue drafts,mergify/merge-queue/*, which run the full suite) plus commitlint over the PR range) anddeploy.yml(adeployand acleanupjob, dormant until the repository variableALCHEMY_DEPLOYistrue); mutation is an on-demand package script and never gates a deploy. Gate: review of the workflow diff.
Commit changes using conventional commits (<type>(<scope>): <subject>). Ensure the working tree is clean and pushed; CI runs pnpm check:ci, never run it locally.