Skip to content

Commit 89dc5fe

Browse files
Merge pull request #1835 from codeflash-ai/update-claude-md
update claude.md
2 parents 5cef345 + ad329cf commit 89dc5fe

1 file changed

Lines changed: 4 additions & 14 deletions

File tree

CLAUDE.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Project Overview
44

5-
CodeFlash is an AI-powered code optimizer that automatically improves performance while maintaining correctness. It supports Python, JavaScript, and TypeScript, with more languages planned. It uses LLMs to generate optimization candidates, verifies correctness through test execution, and benchmarks performance improvements.
5+
CodeFlash is an AI-powered code optimizer that automatically improves performance while maintaining correctness. It supports Python, JavaScript, TypeScript, Java with more languages planned. It uses LLMs to generate optimization candidates, verifies correctness through test execution, and benchmarks performance improvements.
66

77
## Optimization Pipeline
88

@@ -18,19 +18,9 @@ Discovery → Ranking → Context Extraction → Test Gen + Optimization → Bas
1818
6. **Benchmarking** (`benchmarking/`): Measure performance, select best candidate by speedup
1919
7. **Result** (`result/`, `github/`): Create PR with winning optimization
2020

21-
## Domain Glossary
22-
23-
- **Optimization candidate**: A generated code variant that might be faster (`OptimizedCandidate`)
24-
- **Function context**: All code needed for optimization — split into read-writable (modifiable) and read-only (reference)
25-
- **Addressable time**: Time a function spends that could be optimized (own time + callee time / call count)
26-
- **Candidate forest**: DAG of candidates where refinements/repairs build on previous candidates
27-
- **Replay test**: Test generated from recorded benchmark data to reproduce real workloads
28-
- **Tracer**: Profiling system that records function call trees and timings (`tracing/`, `tracer.py`)
29-
- **Worktree mode**: Git worktree-based parallel optimization (`--worktree` flag)
30-
31-
## PR Reviews
32-
33-
- GitHub PR comments and review feedback can be stale — they may reference issues already fixed by a later commit. Before acting on review feedback, verify it still applies to the current code. If the issue no longer exists, resolve the conversation in the GitHub UI.
21+
# Instructions
22+
- When I report a bug, don't start by trying to fix it. Instead, start by writing a test that reproduces the bug. Then, have subagents try to fix the bug and prove it with a passing test.
23+
- Everything that can be tested should have tests.
3424

3525
<!-- Section below is auto-generated by `tessl install` - do not edit manually -->
3626

0 commit comments

Comments
 (0)