Skip to content

CLAUDE.md

Latest commit

 

History

History
47 lines (39 loc) · 2.39 KB

CLAUDE.md

File metadata and controls

47 lines (39 loc) · 2.39 KB
Raw

Repository instructions

Vector Store is a Rust service that provides vector search for ScyllaDB.

Before making changes, follow the project's contributor and coding guidelines:

  • CONTRIBUTING.md — pre-review checklist, commit and PR organization (subject format, patch structure, Jira references), static checks, how to run the tests (unit/integration, the validator harness, and the example docker-compose stacks), CI expectations, and the OpenAPI workflow.
  • docs/rust_instructions.md — Rust coding conventions and best practices used throughout the codebase.

Quick reference

  • Format and lint before committing, matching CI (warnings are errors): 
    cargo fmt --all --check
cargo clippy --workspace --all-targets -- -Dwarnings
  • Run unit and integration tests: cargo test --workspace (--workspace is needed because default-members is only crates/vector-store).
  • Run the end-to-end validator harness: see the Testing section of CONTRIBUTING.md.
  • Do not hand-edit api/openapi.json; regenerate it with cargo openapi.
  • Organize commits and PRs per the Commit and PR Organization section of CONTRIBUTING.md (subject format module: changes, small self-contained patches, and Fixes:/Refs: VECTOR-<n> references).

Skills

Repository skills live in .claude/skills/:

  • daily-ci-triage — triage failed runs of the Daily workflow (daily.yml): group failures by cause, run an initial investigation (history, bisect over vector-store commits and scylla-nightly builds, fixes in flight), check the VECTOR Jira project for duplicates, then comment on the existing issue or file a new one. Built to run unattended as a daily routine; dry-run writes nothing to Jira. SKILL.md holds the procedure; reference.md holds the reasoning and worked examples from past Daily failures.
  • vector-store-release — cut a release: check the cut point and CI, read the PRs since the previous release and the release-relevant diffs PR descriptions miss, write the release notes with the hidden Slack announcement block, and after the user approves them tag, publish, watch the release workflow and verify the Slack post, Docker Hub, release assets and the siren PR. dry-run stops before anything is pushed. Ends with a retrospective proposing improvements to the skill.