Contributing to BeadSpec

Thank you for your interest in contributing. Before diving in, please read CODE_OF_CONDUCT.md.

Quick links

• Architecture — how BeadSpec is structured
• OpenSpec workflow — the spec-first contribution process
• Testing — running tests
• Release process — how releases are cut

Getting the repo running

Prerequisites

Tool	Install
Rust stable	curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
Bun	curl -fsSL https://bun.sh/install | bash
bd CLI	brew install bd (macOS) or download
Platform toolchain	See below

macOS: xcode-select --install

Windows: Visual Studio 2022 Build Tools with C++ workload

Ubuntu/Debian:

sudo apt-get install libwebkit2gtk-4.1-dev libssl-dev libayatana-appindicator3-dev \
  librsvg2-dev libgtk-3-dev patchelf build-essential

Clone and run

git clone https://github.com/boardthatpowder/BeadSpec.git
cd BeadSpec
bun install
bun run tauri dev

Contribution workflow

1. Fork and create a branch from main
2. For behavior changes: check openspec/specs/<feature>/spec.md before coding — see OpenSpec Workflow
3. Make your change with small, atomic commits
4. Run the full test suite (see Testing)
5. Update docs-site/ for any user-facing changes
6. Open a PR against main

License

By contributing to BeadSpec, you agree your contributions are dual-licensed under MIT and Apache-2.0, matching BeadSpec's own license.