Skip to content

Commit ef92054

Browse files
haasonsaasclaude
andcommitted
Add CLAUDE.md with project conventions and dev setup
Provides persistent context for Claude Code sessions: Rust stack, multi-model AI, Vault integration, and self-hosted deployment conventions. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 364043d commit ef92054

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

CLAUDE.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# DiffScope - AI Code Review Engine
2+
3+
## Quick Reference
4+
```bash
5+
cargo build # Build
6+
cargo test # Run tests
7+
cargo run -- --help # CLI usage
8+
```
9+
10+
## Architecture
11+
- **Language**: Rust
12+
- **Database**: PostgreSQL (via sqlx with compile-time checked queries)
13+
- **AI providers**: Multi-model support (Anthropic primary, OpenAI, OpenRouter)
14+
- **Deployment**: Docker → k3s via Helm chart in `charts/`
15+
- **GitHub integration**: GitHub App auth (not PATs)
16+
17+
## Key Directories
18+
- `src/` — Core analysis engine, CLI, API
19+
- `charts/` — Helm chart for k8s deployment
20+
- `migrations/` — PostgreSQL migrations (sqlx)
21+
- `eval/` — Evaluation and benchmarking
22+
- `examples/` — Usage examples
23+
24+
## Conventions
25+
- Use frontier models for reviews — never default to smaller models
26+
- Vault integration for secrets management (HashiCorp Vault)
27+
- GitHub App authentication over personal access tokens
28+
- Wide events for observability (OpenTelemetry-compatible)
29+
- Self-hosted first: Ollama/vLLM/LM Studio should be first-class providers

0 commit comments

Comments
 (0)