Problem
New contributors have no guidance on how to set up the development environment, run tests, or submit changes. The repository currently lacks:
- A
CONTRIBUTING.md file
- Development setup instructions
- Code style conventions
- PR submission guidelines
Proposed Solution
Create a CONTRIBUTING.md at the project root covering:
- Prerequisites — Node.js 22-26, npm
- Getting Started — Fork, clone,
npm install, npm run build
- Development Workflow — Branch naming, making changes,
npm run typecheck + npm test
- Code Style — TypeScript strict mode, ESM modules, existing conventions
- Testing — How to run all tests (
npm test), individual tests (npm run test:*), smoke tests (npm run smoke:*)
- Pull Request Process — What to include, how PRs are reviewed
- Project Structure — Overview of
apps/, libs/, scripts/, skills/
Why This Matters
- Lowers the barrier for first-time contributors
- Sets clear expectations for contributions
- Reduces review overhead by standardizing PR format
Problem
New contributors have no guidance on how to set up the development environment, run tests, or submit changes. The repository currently lacks:
CONTRIBUTING.mdfileProposed Solution
Create a
CONTRIBUTING.mdat the project root covering:npm install,npm run buildnpm run typecheck+npm testnpm test), individual tests (npm run test:*), smoke tests (npm run smoke:*)apps/,libs/,scripts/,skills/Why This Matters