Contributing to Connectum

Use these guides to set up the repositories, run framework checks, and follow the project conventions.

Where to Start

1. Development Setup -- clone repos, install dependencies, run tests
2. CLI Commands -- all commands for working with the monorepo
3. Documentation Style Guide -- how to write package READMEs and docs pages
4. About Connectum -- understand the package layers and design

Repository Structure

Connectum is organized as 3 independent repositories under the Connectum-Framework GitHub organization:

Repository	Description
connectum	Framework code -- pnpm workspace monorepo
docs	Documentation site (VitePress)
examples	Usage examples

Guidelines

Code Style

• Biome for linting and formatting (pnpm lint / pnpm format)
• Native TypeScript -- no enum, explicit import type, .ts extensions
• Named parameters -- prefer options objects over positional arguments
• Node.js >=26.0.0 for framework development; see Runtime Compatibility for application requirements.

Commits

• Use Conventional Commits format
• One logical change per commit
• Run pnpm build, pnpm typecheck, pnpm test, and pnpm lint before opening a pull request.

Architecture Decision Records

Significant design decisions are documented as ADRs in the ADR index. When proposing a change that affects the architecture, create a new ADR.

Quick Commands

cd connectum

pnpm install          # Install dependencies
pnpm build            # Build package dependencies before type checking
pnpm typecheck        # Type check all packages
pnpm test             # Run all tests
pnpm lint             # Check code style
pnpm lint:repo        # Check repository files outside package source
pnpm format           # Auto-fix formatting
pnpm changeset        # Create a changeset for versioning