Owlerlay/AGENTS.md

Repository Guidelines

Learning-First Collaboration Rules

This is a learning project. The assistant is a guide, not an implementer.

• The developer writes all application code and tests.
• The assistant must not write or modify project source code (for example src/ or src-tauri/src/).
• The assistant may provide step-by-step guidance, debugging help, reviews, architecture feedback, and hints.
• The assistant may edit documentation files when explicitly requested.
• If asked to implement code, the assistant should refuse and provide a clear plan the developer can execute.
• If asked about a file, function, module, or crate, the assistant must read the current code first before answering.
• Reviews and guidance must be based strictly on the current file contents, not earlier snapshots.

Project Structure & Module Organization

This repository is a Tauri app with a TypeScript frontend and Rust backend.

• src/: frontend code (main.ts, styles.css, and static assets in src/assets/).
• src-tauri/src/: Rust entry points and Tauri commands (main.rs, lib.rs).
• src-tauri/icons/: app icons used for desktop bundles.
• src-tauri/tauri.conf.json: Tauri app/build configuration.
• dist/ and src-tauri/target/: build outputs (generated; do not edit manually).

Build, Test, and Development Commands

• pnpm install: install JavaScript dependencies.
• pnpm dev: run the Vite web dev server at http://localhost:1420.
• pnpm tauri dev: run the app in development mode.
• pnpm build: type-check (tsc) and build frontend assets into dist/.
• pnpm tauri build: create desktop bundles.
• pnpm preview: preview the frontend bundle.
• cargo test --manifest-path src-tauri/Cargo.toml: run Rust tests.

Coding Style & Naming Conventions

• TypeScript: 2-space indentation, strict mode is enabled; prefer explicit types at API boundaries.
• TypeScript naming: camelCase for variables/functions, PascalCase for types/interfaces.
• Rust: use Edition 2024, follow rustfmt defaults (4-space indentation), and use snake_case for functions/modules.
• Keep Tauri commands small and side-effect focused; expose them from src-tauri/src/lib.rs.
• Use descriptive file names by feature (for example, src/settings-panel.ts).

Testing Guidelines

No automated JS test framework is currently configured. For new features:

• add Rust unit tests near command logic (#[cfg(test)] in src-tauri/src/), and
• add frontend tests only when introducing non-trivial UI/state behavior (Vitest is the preferred choice if added).
• include manual verification steps in PRs (OS, command run, expected behavior).

Commit & Pull Request Guidelines

Git history is not available in this workspace snapshot, so use Conventional Commit style:

• feat: add tray menu action
• fix: handle empty greet input

PRs should include:

• a short problem/solution summary,
• linked issue(s) when applicable,
• screenshots or recordings for UI changes,
• exact verification commands run (for example, pnpm tauri dev, pnpm build).