Contributing #

Shard is in active development. Before opening a large pull request, start a discussion or issue so the intended protocol and architecture boundaries can be agreed first.

Setup #

git clone <repository-url>
cd shard
bun install --frozen-lockfile
bun run check

Bun 1.3 or newer is required.

Pull requests #

• Keep changes focused and explain user-visible or protocol-visible behavior.
• Add or update tests for behavioral changes.
• Preserve the layer dependency rule described in ARCHITECTURE.md.
• Do not commit API keys, session transcripts, daemon credentials, or files from ~/.shard.
• Run bun run check before requesting review.
• Update relevant design, architecture, protocol, or deployment documents when their contracts change.

Commit messages #

Use concise, imperative subjects. Conventional prefixes such as feat:, fix:, docs:, and test: are welcome but not required.

Reporting bugs #

Include the Shard commit, Bun version, operating system, client used, and a minimal reproduction. Redact prompts, model output, file paths, credentials, and session data as needed.

License #

By contributing, you agree that your contributions will be licensed under the Apache License 2.0.