docs: add CLAUDE.md (RM-2184)

RM
2d ago
+57-0

User description

Adds a CLAUDE.md that imports AGENTS.md and holds Claude-specific notes only: a command table with verified/not-run status, an architecture map, invariants and non-goals, and gotchas.

Verified locally (Linux, CPU only): cargo fmt --check, default and all-features clippy with -D warnings, cargo build, cargo test, RUSTDOCFLAGS='-D warnings' cargo doc --all-features --no-deps, and cargo llvm-cov on 1.99.0, plus the MSRV job's fmt, clippy, build, and test on 1.97.1.
Not run: the #[ignore] real-GGUF pilots (need multi-GB weights), the Qlty/Codecov CI steps, and the cargo package/cargo publish --dry-run release gate.

The Cargo.toml include list is an allowlist that does not name AGENTS.md, so CLAUDE.md is left out of it the same way. No other files changed.

Closes RM-2184

Generated by Claude Code

Devin Review

Summary by cubic

Adds a CLAUDE.md at the repo root that imports AGENTS.md and holds Claude-specific notes only: a verified/unverified command table, architecture map, invariants and non-goals, and gotchas. Closes RM-2184.

  • The listed commands were verified locally on Linux on Rust 1.99.0 and MSRV 1.97.1; the #[ignore] real-GGUF tests, Qlty/Codecov CI steps, and the cargo package/cargo publish --dry-run release gate are marked as not run.
  • The release-gate commands and publishing are documented as run by the maintainer only, never from an agent session.
  • CLAUDE.md is left out of the Cargo.toml include allowlist (which lists the manifest, Cargo.lock, README, changelog, licenses, and source dirs) the same way AGENTS.md is, so no manifest change was needed. No other files changed.

CodeAnt-AI Description

Add Claude-specific project guidance and verified commands

What Changed

  • Adds a Claude guide that reuses shared repository instructions and explains the project layout, constraints, and common pitfalls
  • Lists verified build, test, and documentation checks, and identifies checks that were not run

Impact

✅ Clearer guidance for Claude-assisted changes
✅ Verified commands for supported Rust versions
✅ Fewer accidental release or generated-file changes

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

Summary by CodeRabbit

  • Documentation
    • Added repository guidance covering project structure, verified commands, key constraints, and release considerations.