chore(guide): update contributing guide

[icecrasher321]

Summary

Update contributing guide

Type of Change

• Documentation

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
docs	Ready	Preview, Comment	Apr 25, 2026 1:44am

[cursor]

PR Summary

Low Risk
Low risk documentation-only changes; no production code paths are modified. Main risk is minor developer confusion if instructions don’t match current scripts/paths.

Overview
Updates .github/CONTRIBUTING.md to reflect the current Turborepo layout (including apps/realtime) and enforces the one-way dependency convention.

Clarifies local development setup with per-app .env files, shared-secret mirroring commands, the canonical DB migration flow (packages/db db:migrate), and how to run app/realtime servers together or separately, plus the recommended pre-PR CI check commands.

Improves the “Adding New Blocks and Tools” section by linking to .agents/skills/* guides, correcting registry/file paths and example imports, and tightening formatting/consistency throughout.

^{Reviewed by Cursor Bugbot for commit 751652b. Configure here.}

[greptile-apps]

Greptile Summary

This PR significantly expands CONTRIBUTING.md with accurate monorepo architecture details (apps/realtime/, shared @sim/* packages, one-way dependency rule), rewrites the "Manual Setup" section with complete env-file, migration, and CI-check commands, and adds a skill-guide reference table pointing to .agents/skills/ SKILL.md files that exist in the repo.

The previously flagged gaps (missing clone/checkout commands, incomplete Option 4 steps, missing block/tool code examples, and inverted backtick-bold syntax on visibility bullets) all appear to be resolved in this revision.

Confidence Score: 5/5

Documentation-only PR with no code changes; safe to merge.

All changes are in CONTRIBUTING.md. Previously identified gaps are resolved, referenced SKILL.md files exist, and no new logical or security issues were found. No application code is touched.

No files require special attention.

Important Files Changed

Filename	Overview
.github/CONTRIBUTING.md	Comprehensive documentation update: adds monorepo overview, completes all setup steps with working commands, fixes code-example typos (/@tools → @/tools, trailing commas in TS samples), and introduces a SKILL.md reference table with valid relative links.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Contributor] --> B{Choose setup method}
    B --> C[Option 1: CLI]
    B --> D[Option 2: Docker Compose]
    B --> E[Option 3: Dev Container / Codespaces]
    B --> F[Option 4: Manual Setup]

    F --> F1["1. Clone & bun install"]
    F1 --> F2["2. Copy .env files\n(apps/sim, apps/realtime, packages/db)"]
    F2 --> F3["3. cd packages/db && bun run db:migrate"]
    F3 --> F4["4. bun run dev:full\n(Next.js :3000 + Socket.IO :3002)"]
    F4 --> F5["5. type-check / lint:check / test before PR"]

Loading

_{Reviews (2): Last reviewed commit: "fix md" | Re-trigger Greptile}

[icecrasher321]

@greptile

[icecrasher321]

bugbot run

[cursor]

✅ Bugbot reviewed your changes and found no new issues!

Comment @cursor review or bugbot run to trigger another review on this PR

^{Reviewed by Cursor Bugbot for commit 751652b. Configure here.}