Contributing to PLOMID

Build, test, review, and extend the engine — derived from the repo, not invented.

Version
Latest
v0.1.0 · latest 2 min read
On this page
  1. Local development (required gates)
  2. Test tiers
  3. Pull requests
  4. Adding SQL functionality
  5. Adding storage functionality

Local development (required gates)#

shsource
cargo build --workspace
cargo fmt --check
cargo clippy --workspace --all-targets -- -D warnings
make test-ci
cargo deny check

Install cargo-deny. CI runs the same gates plus license/advisory/source policy.

Test tiers#

Tier Command What runs Where
A — fast unit make test-unit isolated src/ unit tests, no scale/bench workloads every PR + release
B — bounded integration make test-integration all tests/ targets (SQL, txn, storage, index, WAL/recovery, protocol, regressions); #[ignore] scale gates off every PR + release
C — required verification make test-ci (= A + B, plus CI jobs for fmt/check/clippy/deny) routine correctness gate, 30-min budget every PR + release
D — heavy/explicit make test-scale (--include-ignored + scale env), make bench-check, make gauntlet scale/load/soak/fuzz-200, criterion benches, HTAP Gauntlet nightly schedule or manual dispatch only

Install cargo-deny. CI runs the same gates plus license/advisory/source policy.

Pull requests#

  • One task per PR; preserve roadmap dependency order.
  • Tests for behavior changes; storage/WAL/recovery/MVCC/txn changes need correctness + failure-path coverage.
  • Public API/architecture changes need docs; material design decisions need an ADR (docs/adr/ convention per CONTRIBUTING.md).
  • State validation, limitations, follow-ups. No secrets or forbidden engine foundations. Review via CODEOWNERS.

Adding SQL functionality#

Parser (crates/sql/src/parser/* + ast.rs) → executor (query/*, join/*, scalar.rs, dml.rs) → tests in tests/*.sql + crates/*/tests. Update Compatibility status and add cookbook examples. See Repo structure.

Adding storage functionality#

crates/storage (layout/manager/row/btree/buffer/checksum/catalog) + crates/wal (format/recovery) + crates/txn/mvcc → mount/demount lifecycle + corruption/replay tests. Document as Internal unless promoted to a developer contract.

Structure: Repo structure

Was this page helpful?