mirror of
https://github.com/codeflash-ai/codeflash-agent.git
synced 2026-05-04 18:25:19 +00:00
30 lines
898 B
Markdown
30 lines
898 B
Markdown
|
# Optimization Project Workflow
|
||
|
|
|
||
|
|
## Location
|
||
|
|
|
||
|
|
Active optimization data lives in `.codeflash/{org}/{project}/` on main. Summaries are built into `case-studies/{org}/{project}/`.
|
||
|
|
|
||
|
|
## Status tracking
|
||
|
|
|
||
|
|
Every optimization project has a `status.md` at its root. Update it after every session:
|
||
|
|
|
||
|
|
- What was completed this session
|
||
|
|
- What's next
|
||
|
|
- Current branches in the target repo
|
||
|
|
- VM state (running/deallocated)
|
||
|
|
- Any blockers
|
||
|
|
|
||
|
|
This file persists across sessions -- it's the source of truth for resuming work, not session memory.
|
||
|
|
|
||
|
|
## Recording results
|
||
|
|
|
||
|
|
After every VM benchmark run:
|
||
|
|
|
||
|
|
1. Append to `data/results.tsv` with the commit, target, before/after numbers
|
||
|
|
2. Update `README.md` results table if the optimization is kept
|
||
|
|
3. Update `status.md` with current state
|
||
|
|
|
||
|
|
## Committing
|
||
|
|
|
||
|
|
Commit optimization data changes to main alongside other work. This data is part of the repo, not isolated on branches.
|