Skip to content

Latest commit

 

History

History
25 lines (24 loc) · 2.21 KB

AGENTS.md

File metadata and controls

25 lines (24 loc) · 2.21 KB

DO

  • DO add test to tests folder.
  • Always diag after edit, fix diag error, follow PLAN.md TASKS.md, update plan PLAN.md when complete
  • Add issue in ISSUES.md for fix anything and updated when fixed, keep only last 10 issues, ideally open issues should not over 50%.
  • Then fixed add reflect to REFLECT.md, but keep it short, only critical one.
  • Try to keep all md under 320 lines, keep only important and use short word, less noise, keep revise for compact.
  • Follow modular architecture, Keep coding files under 320-512 lines, sparate to smalelr files if need.
  • Always run cargo clippy --fix --allow-dirty and fix after done edit for Rust files, for frontend just run diagnostic.
  • Ask user for commit when done impl or fixed for each task and run success result without error with git convention e.g. feat:..., fix:..., refactor:... for each task with important list of impl and shrot reflect for later ref, but wait for confirm first.
  • use types.rs, mod.rs is for index only, keep main.rs and lib.rs minimal, less or no logic.
  • prefer match more than if.
  • use early return condition instead of else.
  • when user say handover you must summarize current state and incompleted issues to HANDOVER.md for next thread can follow up easily, refer to ISSUES.md number/title if has.
  • use macos cli commad not linux .e.g timeout is not exist use sleep.
  • search for related code, tests, examples to get an idea and current context before impl.
  • if user say regression try dig to git history to get more idea.
  • fix warning diag before commit but be reason about unused because it maybe meant to use but we forget to use, remove if not used
  • Always diagnostic and fix error before run server.
  • Must use RUST_LOG=info to reduce log noise and better filter the log by target keyword.
  • RESTRICT jupiter_earn tool to position/earnings benchmarks (114-*.yml) only, never add to normal agent tool list.

DONT

  • DONT Add a test on each file, place it in tests folder.
  • DONT run server and get stuck, do run server in background, use cargo watch e.g. nohup cargo watch -w crates/reev-api -x "run -p reev-api --bin reev-api" > logs/reev-api.log 2>&1 & so server will reflect the latest code.
  • DONT run web server.