mirror of https://github.com/codeflash-ai/codeflash.git synced 2026-05-04 18:25:17 +00:00

Kevin Turcios 0061739c03 chore: add mypy to pre-commit config and document setup

- Add mypy as a local pre-commit hook via prek (ruff-check + ruff-format
  + mypy now all run at commit time)
- Add Setup section to CLAUDE.md with uv sync and prek install steps

2026-04-23 04:38:34 -05:00

1.4 KiB

Raw Blame History

CLAUDE.md

Project Overview

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.

Optimization Pipeline

Discovery -> Ranking -> Context Extraction -> Test Gen + Optimization -> Baseline -> Candidate Evaluation -> PR

See .claude/rules/architecture.md for directory mapping and entry points.

Setup

uv sync                  # Install all dependencies
uv run prek install      # Install git pre-commit hooks (ruff + mypy)

Bug Fix Workflow

Follow these steps in order, do not skip ahead:

Read the relevant code to understand the bug
Write a test that reproduces the bug (run it to confirm it fails)
Spawn subagents (using the Agent tool) to attempt the fix — each subagent should apply a fix and run the test to prove it passes
Review the subagent results, pick the best fix, and apply it
Never jump straight to writing a fix yourself — always go through steps 1-4

Everything that can be tested should have tests.

Agent Rules

@.tessl/RULES.md follow the instructions

@AGENTS.md

1.4 KiB Raw Blame History