Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (32 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

44 lines (32 loc) · 1.17 KB

Contributing

Setup

git clone https://github.com/workstream-labs/workstreams.git
cd workstreams
bun install
bun link

Development

bun test                           # run all tests
bun test tests/dag.test.ts         # run one test
bun run apps/cli/src/index.ts -- --help     # run CLI without building

Project layout

packages/core/src/   Shared engine — config, executor, agent spawning, worktree, state
apps/cli/src/        CLI app
  cli/               One file per command (init, create, run, list, dashboard, etc.)
  ui/                TUI components — all raw ANSI, no external TUI library
apps/desktop/        Desktop app (WIP)
tests/               bun:test

Runtime state goes in .workstreams/ (gitignored): worktrees, logs, comments, state JSON.

Submitting changes

  1. Fork and branch from main.
  2. Add tests if you're adding functionality.
  3. bun test should pass.
  4. Open a PR.

Keep PRs small. If the change is large, open an issue first.

Bugs

File at github.com/workstream-labs/workstreams/issues. Include what you did, what happened, and your OS / Bun version.