Contributing to StateLoom

February 13, 2026 ยท View on GitHub

Thank you for your interest in contributing to StateLoom! This document provides a quick overview of how to get started.

For the full contributor guide, see docs/contributing/.

Quick Start

# Fork and clone the repository
git clone https://github.com/<your-username>/stateloom.git
cd stateloom

# Enable corepack and install dependencies
corepack enable
pnpm install

# Build all packages
pnpm build

# Run all tests
pnpm test

Development Workflow

  1. Create a branch: git checkout -b feat/my-feature
  2. Make your changes following the coding guidelines
  3. Write tests (95%+ coverage required)
  4. Run validation: pnpm lint && pnpm typecheck && pnpm build && pnpm test
  5. Create a changeset if you changed published code: pnpm changeset
  6. Submit a pull request

Key Resources

ResourcePath
Coding Guidelinesdocs/contributing/coding-guidelines.md
Testing Guidelinesdocs/contributing/testing-guidelines.md
Documentation Guidelinesdocs/contributing/documentation-guidelines.md
Monorepo Toolingdocs/contributing/monorepo-tooling.md
Architecture Overviewdocs/architecture/architecture-overview.md

Code of Conduct

This project follows the Contributor Covenant Code of Conduct. By participating, you agree to uphold this code.