Contributing
Work on the framework, a front door, or a focused capability.
Set up the repository
git clone https://github.com/manyeya/vibes.git
cd vibes
bun install
bun run dev:apiRun the terminal or web client in another terminal. Consult CLAUDE.md, AGENTS.md, and the current source for architecture conventions.
Build and test
bun run build
bun run test
# Focus on the harness
cd packages/harness-vibes
bun testChoose checks that cover the behavior you change. Keep model-independent tests separate from experiments that require API keys.
Contribution principles
- Add capabilities through plugins and keep the owned loop focused.
- Preserve streaming behavior and typed events.
- Keep sessions isolated and runtime state out of source control.
- Document tool policy and failure behavior alongside new functionality.
- Use the current source when architecture notes disagree with an older example.
Work on this site
node apps/docs-site/build.mjs
python3 -m http.server 8080 --directory apps/docs-site/outDocumentation lives in apps/docs-site/content/pages.mjs. Shared styling and browser interactions live in assets/. The build has no package dependencies. GitHub Actions rebuilds and publishes the site when docs changes land on main.
Improve this page Grounded in the Vibes source.