Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (36 loc) · 1022 Bytes

CONTRIBUTING.md

File metadata and controls

53 lines (36 loc) · 1022 Bytes

Contributing to Sediment

Thanks for your interest in contributing to Sediment!

Getting Started

git clone https://github.com/rendro/sediment.git
cd sediment
cargo build

The first build will download the embedding model (~90MB).

Development

# Build
cargo build

# Run tests
cargo test

# Run ignored tests (require model download)
cargo test -- --ignored

# Lint
cargo clippy --all-targets -- -D warnings

# Format
cargo fmt --all

# Benchmarks
cargo bench

Pull Requests

  1. Fork the repo and create a feature branch
  2. Make your changes
  3. Ensure cargo test, cargo clippy, and cargo fmt --check all pass
  4. Write a clear PR description explaining the change

Architecture

See CLAUDE.md for a detailed architecture overview including:

  • Two-database hybrid design (LanceDB + SQLite)
  • MCP server structure
  • Data flow and key design decisions

Reporting Issues

Use GitHub Issues with the provided templates.