Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (27 loc) · 920 Bytes

CONTRIBUTING.md

File metadata and controls

40 lines (27 loc) · 920 Bytes

Contributing

Minimal workflow for external contributors.

Setup

See the Quick Start for prerequisites and initial setup.

After cloning, run bun install to install dependencies and activate the pre-push hook:

bun install

The hook runs bun run verify before every push. To format code manually: bun run format.

Development loop

  1. Create a branch from main.
  2. Make focused changes.
  3. Run targeted checks while iterating:
bun run test:unit     # unit tests
bun run test:int      # integration tests
bun run test:tui      # visual regression tests
bun run test:perf     # performance baselines
  1. Before opening a PR, run full validation:
bun run verify

Submission expectations

  • Keep PRs small and scoped to one intent.
  • Update canonical docs when behavior or contracts change.
  • Include tests for meaningful regression risk.