src/is the main codebase.src/main/contains core application logic.src/main/mobile/is the mobile app code.src/main/frontend/components/houses UI components.src/main/frontend/inference_worker/andsrc/main/frontend/worker/hold webworker code, including RTC insrc/main/frontend/worker/rtc/.
src/electron/is Electron-specific code.src/test/contains unit tests.deps/contains internal dependencies/modules.clj-e2e/contains end-to-end tests.
bb dev:lint-and-testruns linters and unit tests.bb dev:test -v <namespace/testcase-name>runs a single unit test (example:bb dev:test -v logseq.some-test/foo).- E2E tests live in
clj-e2e/; run them from that directory if needed.
- ClojureScript keywords are defined via
logseq.common.defkeywords/defkeyword; use existing keywords and add new ones in the shared definitions. - Follow existing namespace and file layout; keep related workers and RTC code in their dedicated directories.
- Prefer concise, imperative commit subjects aligned with existing history (examples:
fix: download,enhance(rtc): ...). - Clojure map keyword name should prefer
-instead of_, e.g.:user-idinstead of:user_id.
- Unit tests live in
src/test/and should be runnable viabb dev:lint-and-test. - Name tests after their namespaces; use
-vto target a specific test case. - Run lint/tests before submitting PRs; keep changes green.
- Commit subjects are short and imperative; optional scope prefixes appear (e.g.,
fix:orenhance(rtc):). - PRs should describe the behavior change, link relevant issues, and note any test coverage added or skipped.
- Review notes live in
prompts/review.md; check them when preparing changes. - DB-sync feature guide for AI agents:
docs/agent-guide/db-sync/db-sync-guide.md. - DB-sync protocol reference:
docs/agent-guide/db-sync/protocol.md. - New properties should be added to
logseq.db.frontend.property/built-in-properties. - Avoid creating new class or property unless you have to.
- Avoid shadow var, e.g.
bytesshould be named aspayload.