Contributing
quarry is a personal project with a narrow scope: an IDE for Rust and C/C++ that matches CLion on the daily loop. Changes that widen the scope — another language, a plugin API, remote development — are out of scope by design, not by accident.
The gate
bun run gateNine steps, all of them required: file size, types, formatting, lint, frontend tests, and the four
Rust steps (cargo fmt --check, cargo check --all-targets, cargo test, cargo clippy -D warnings). One invocation reports the whole picture; a failing step prints its own tail.
| Step | Command |
|---|---|
| Types | bun check (Bun's checker, nearest tsconfig per file) |
| Format | bun fmt --check (tabs, 4 wide, 100 columns) |
| Lint | biome lint . |
| Tests | bun test over the pure helpers |
| Rust | cargo fmt --check, check --all-targets, test, clippy |
House rules
- No file over 200 lines.
scripts/check-file-size.tsfails on a new offender and on a stale exception indocs/refactor/oversized.txt, so the list only shrinks. Split Rust by module directories and stylesheets withbun scripts/split-css.ts. src/only, with@/*mapped to./src/*. Logic insrc/lib, rendering insrc/ui, and the feature name kept on both sides.- Bun only. No npm, and
bun run <script>only where the name collides with a builtin. - A formatter is never a gate.
bun fmtwrites;bun fmt --checkverifies. - Never a measured number in a commit message. Name the gates, not their totals.
Smoke scripts
The language servers and the debugger are only exercised by hand:
bun run scripts/lsp-smoke.ts # initialize handshake
bun run scripts/lsp-ux-smoke.ts # hover, completion, definition, references
bun run scripts/dap-spike.ts # capabilities, memory, breakpoints, formatters
bun run scripts/cxx-smoke.ts # clang diagnostics, missing-cmake pathThey need a real rust-analyzer, lldb-dap and clangd, which is why CI does not run them.
Releasing
Alphas publish from a Mac, and land like any other change: main is protected, so the bump goes
through a pull request and the tag is cut on the merged commit.
git switch -c release/alpha.N # never push to main, it is protected
bun scripts/bump-version.ts alpha # 0.1.0-alpha.N across the five version files
git commit -am "chore: bump to 0.1.0-alpha.N"
git push origin HEAD:refs/heads/release/alpha.N
gh pr create --fill # one approving review is required
gh pr merge --squash
git switch main && git pull
git tag quarry-alphaN && git push origin quarry-alphaN
bun run release:local # gate, signed universal build, release, manifest checkrelease:local refuses a commit whose CI run failed or was cancelled, runs the gate itself, signs the
bundle, publishes the release and then fetches the public manifest to prove it serves the version it
just published.