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
- Create a branch:
git checkout -b feat/my-feature - Make your changes following the coding guidelines
- Write tests (95%+ coverage required)
- Run validation:
pnpm lint && pnpm typecheck && pnpm build && pnpm test - Create a changeset if you changed published code:
pnpm changeset - Submit a pull request
Key Resources
| Resource | Path |
|---|---|
| Coding Guidelines | docs/contributing/coding-guidelines.md |
| Testing Guidelines | docs/contributing/testing-guidelines.md |
| Documentation Guidelines | docs/contributing/documentation-guidelines.md |
| Monorepo Tooling | docs/contributing/monorepo-tooling.md |
| Architecture Overview | docs/architecture/architecture-overview.md |
Code of Conduct
This project follows the Contributor Covenant Code of Conduct. By participating, you agree to uphold this code.