From aa0e153153c04c69a5117a4b84281a45341ca066 Mon Sep 17 00:00:00 2001 From: rcmerci Date: Thu, 25 Sep 2025 19:08:27 +0800 Subject: [PATCH] dev: add AGENTS.md --- AGENTS.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000000..fd80863ad3 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,22 @@ +## Repository Layout +- `src/`: Core source code + - `src/main/`: The core logic of the application + - `src/main/mobile/`: Mobile app code + - `src/main/frontend/inference_worker/`: Code running in a webworker for text-embedding and vector-search + - `src/main/frontend/worker/`: Code running in an another webworker + - `src/main/frontend/worker/rtc/`: RTC(Real Time Collaboration) related code + - `src/main/frontend/components/`: UI components + - `src/electron/`: Code specifically for the Electron desktop application. + - `src/test/`: unit-tests +- `deps/`: Internal dependencies/modules +- `clj-e2e/`: End to end test code + +## Testing Commands +- Run linters and unit-tests: `bb dev:lint-and-test` +- Run single focused unit-test: + - Add the `:focus` keyword to the test case: `(deftest ^:focus test-name ...)` + - `bb dev:test -i focus` + +## Review Checklist +- Linters and unit-tests must pass +- Check the review notes listed in `prompts/review.md`.