Skip to content

Commit 302b030

Browse files
committed
docs: add CLAUDE.md with pre-push checklist
1 parent a599ac6 commit 302b030

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# CLAUDE.md
2+
3+
## Project Overview
4+
5+
A DataFusion extension crate for vector similarity search (ANN) using USearch HNSW indices. Provides optimizer rules, UDFs (l2_distance, cosine_distance, negative_dot), and pluggable lookup providers (Parquet, SQLite) for retrieving non-embedding columns by key.
6+
7+
## Git Commits
8+
9+
Use conventional format: `<type>(<scope>): <subject>` where type = feat|fix|docs|style|refactor|test|chore|perf. Subject: 50 chars max, imperative mood ("add" not "added"), no period.
10+
11+
## Pre-Push Checklist
12+
13+
Always run these before pushing:
14+
15+
1. `cargo fmt --check` — fix any formatting issues
16+
2. `cargo clippy -- -D warnings` — no warnings allowed
17+
3. `cargo test --features sqlite-provider` — all tests must pass (sqlite-provider feature needed for SQLite provider tests)

0 commit comments

Comments
 (0)