Thanks for your interest! This file is a quick on-ramp; the agent rules in .agents/rules/ are the canonical source for conventions.
- Node.js 22.19+ (the supported floor — CI and
.node-versionuse 24) - pnpm 11+
- Docker (for integration tests)
git clone https://github.com/btravstack/temporal-contract.git
cd temporal-contract
pnpm install
pnpm build
pnpm test- Create a branch from
main. - Make your changes. Workflow code must be deterministic — see
.agents/rules/workflow-determinism.md. - Run quality checks (
pnpm typecheck && pnpm lint && pnpm format --check && pnpm test && pnpm knip). - Create a changeset:
pnpm changeset. - Submit a pull request.
Pre-commit hooks (Lefthook) run formatting + linting; commit-msg hooks validate Conventional Commits.
| Topic | File |
|---|---|
| Project architecture | .agents/rules/project-overview.md |
| Commands, release flow, commit types | .agents/rules/commands.md |
| Defining a contract | .agents/rules/contract-patterns.md |
Activities, workflows, cancellation, ApplicationFailure |
.agents/rules/handlers.md |
| Workflow determinism (READ FIRST) | .agents/rules/workflow-determinism.md |
| Code style + strict-mode quirks | .agents/rules/code-style.md |
| Test conventions | .agents/rules/testing.md |
| Dependencies + peer-dep policy | .agents/rules/dependencies.md |
| Adding a new package | .agents/rules/adding-a-package.md |