Zhengchao AnandGitHub
c066faf07a
fix(docs): update stale docs/README.md references to docs/architecture/README.md The file docs/README.md was removed in a previous commit but references in AGENTS.md, ARCHITECTURE.md, and CLAUDE.md were not updated. The expanded check_doc_paths.sh now catches these stale references.
2.2 KiB
RustFS — CLAUDE.md
S3-compatible object store in Rust, derived from MinIO. Erasure-coded, multi-pool, supports ILM tiering/lifecycle.
Agent rules (change style, verification, PR conventions, scoped per-crate guidance) live in AGENTS.md — follow it. This file only adds what Claude Code needs on top: commands and pointers.
Commands
cargo build --release --bin rustfs # production binary
cargo check -p <crate> # fast type-check one crate
cargo test -p <crate> # test one crate
cargo fmt --all # format (required before PR)
make pre-commit # fast gate: fmt + arch checks + quick-check (NO clippy/tests)
make pre-pr # optional full gate for broad cross-module changes
make build-docker BUILD_OS=ubuntu22.04
Docker build note:
buildx buildwithout--loadkeeps the image in the buildx cache only —docker runwill use a stale local image. The Makefile already includes--load; if you suspect a stale binary, add--no-cacheto thebuildx buildinvocation inside.config/make/build-docker.mak.
Where to look (do not duplicate here)
- Agent knowledge base index and doc-writing rules: docs/architecture/README.md
- Crate membership:
Cargo.toml[workspace].members - Architecture, layering, crate map: ARCHITECTURE.md
- Migration guardrails & readiness contracts: docs/architecture/
- CI workflow steps:
.github/workflows/; event, timeout, and required-status matrix: docs/testing/ci-gates.md - Test-layer taxonomy, per-layer entry commands, serial/nextest rules, flake policy: docs/testing/README.md
- Tier/ILM transition debugging (xl.meta inspection, versionId tracing): docs/operations/tier-ilm-debugging.md
Domain conventions worth knowing up front
Repo-wide domain invariants (dual internal metadata keys, defensive UUID reads, unversioned tier buckets) live in AGENTS.md under "Cross-Cutting Domain Invariants" — read them before touching metadata or tiering code.