Skip to content

Commit 307b1cf

Browse files
committed
add caching guidance and session progress log to documentation
1 parent 1b04cbe commit 307b1cf

2 files changed

Lines changed: 18 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,15 @@ julia --project -e 'using BenchmarkTools; include("benchmark/benchmarks.jl"); ru
7272

7373
- Avoid second-person phrasing (“you”) in docs and docstrings.
7474

75+
## Caching Guidance
76+
77+
- For constant calculations that can be computed once and reused, compute lazily on first use and store in the model struct cache; subsequent use must read from the cache.
78+
79+
## Session Progress Log
80+
81+
- Always take stock of what was done and what remains, and save it in `AGENT_PROGRESS.md`.
82+
- At the start of a new session, always read `AGENT_PROGRESS.md` before making changes.
83+
7584
## Common Change Points
7685

7786
- New API: add in `src/get_functions.jl` and export from `src/MacroModelling.jl`.

CLAUDE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,15 @@ The constant `SYMPYWORKSPACE_RESERVED_NAMES` in `MacroModelling.jl` lists names
174174

175175
- Avoid second-person phrasing (“you”) in docs and docstrings.
176176

177+
### Caching Guidance
178+
179+
- For constant calculations that can be computed once and reused, compute lazily on first use and store in the model struct cache; subsequent use must read from the cache.
180+
181+
### Session Progress Log
182+
183+
- Always take stock of what was done and what remains, and save it in `AGENT_PROGRESS.md`.
184+
- At the start of a new session, always read `AGENT_PROGRESS.md` before making changes.
185+
177186
## Testing Patterns
178187

179188
Tests use Julia's `Test` module with `@testset` blocks:

0 commit comments

Comments
 (0)