diff --git a/agents.md b/agents.md new file mode 100644 index 0000000..47a762a --- /dev/null +++ b/agents.md @@ -0,0 +1,24 @@ +# AGENTS.md + +## Task Completion Requirements + +- All of `bun fmt`, `bun lint`, and `bun typecheck` must pass before considering tasks completed. +- NEVER run `bun test`. Always use `bun run test` (runs Vitest). + +## Project Snapshot + +Neon Code is a comprehensive portoflio management and equity research platform. It helps analysts manage their portfolio, organize research and view individual stocks. + +This repository is a VERY EARLY WIP. Proposing sweeping changes that improve long-term maintainability is encouraged. + +## Core Priorities + +1. Performance first. +2. Reliability first. +3. Keep behavior predictable under load and during failures (session restarts, reconnects, partial streams). + +If a tradeoff is required, choose correctness and robustness over short-term convenience. + +## Maintainability + +Long term maintainability is a core priority. If you add new functionality, first check if there are shared logic that can be extracted to a separate module. Duplicate logic across mulitple files is a code smell and should be avoided. Don't be afraid to change existing code. Don't take shortcuts by just adding local logic to solve a problem.