32 lines (23 loc) · 738 Bytes

Contributing

Thanks for considering a contribution to CodeRelay.

Before you start

Use Node.js 20+
Never commit secrets, tokens, QR payloads, local pairing state, or runtime logs
Keep public docs in docs/
Keep project planning notes in project-docs/

Local setup

nvm use
npm install
npm run typecheck

Project structure

apps/: runnable apps
packages/: reusable packages
docs/: public documentation for users and contributors
project-docs/: planning and design notes

Pull request expectations

Keep changes focused
Add or update docs when behavior changes
Prefer example config over hard-coded credentials
Call out any security-sensitive decisions in the PR description