Skip to content

Commit aca40d3

Browse files
committed
AGENTS.md: Add app/ folder development notes
Agents were getting lost when app/ folder changes were being made.
1 parent 697ccb9 commit aca40d3

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

AGENTS.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ default_agent: "@dev-agent"
2828
> - `/docs/development/index.md` - Main development guide with build/run commands
2929
> - `/docs/development/frontend.md` - Frontend development guide
3030
> - `/docs/development/backend.md` - Backend development guide with testing commands
31+
> - `/docs/development/app.md` - Desktop app development guide
3132
> - `/docs/development/testing.md` - Load testing guide
3233
> - `/docs/development/architecture.md` - Architecture documentation
3334
> - `/docs/development/plugins/index.md` - Plugin system overview
@@ -83,7 +84,7 @@ should NOT unless explicitly requested or strictly necessary for the change
8384
- **`backend/`** — Go server and API; see `/backend/README.md` and `/docs/development/backend.md` for server commands.
8485
- **`docs/`** — all developer and user docs; reference specific files under `docs/` for workflows.
8586
- **`plugins/`** — plugin system and examples; see `/plugins/README.md` and `/docs/development/plugins/`.
86-
- **`app/`** — desktop application (Electron); see `/app/README.md`.
87+
- **`app/`** — desktop application (Electron); see `/app/README.md` and `/docs/development/app.md` for build/run/test commands.
8788
- **CI & infra:** `.github/workflows/`, Dockerfiles (`/Dockerfile`, `/Dockerfile.plugins`), Kubernetes manifests (`kubernetes-headlamp*.yaml`), Helm charts (`/charts/`) — treat as manual-review-only.
8889

8990
---
@@ -117,10 +118,13 @@ should NOT unless explicitly requested or strictly necessary for the change
117118
- **Lint backend (fix):** `npm run backend:lint:fix` (from `/package.json`, documented in `/docs/development/backend.md`)
118119
- **Lint frontend:** `npm run frontend:lint` (from `/package.json`)
119120
- **Lint frontend (fix):** `npm run frontend:lint:fix` (from `/package.json`)
121+
- **Lint app:** `npm run app:lint` (from `/package.json`, documented in `/docs/development/app.md`)
122+
- **Lint app (fix):** `npm run app:lint:fix` (from `/package.json`, documented in `/docs/development/app.md`)
120123

121124
#### Format commands (from `/package.json` and `/docs/development/backend.md`):
122125
- **Format backend:** `npm run backend:format` (from `/package.json`, documented in `/docs/development/backend.md`)
123126
- **Format and lint frontend:** `npm run frontend:lint:fix` (from `/package.json`)
127+
- **Format app:** `npm run app:format` (from `/package.json`, documented in `/docs/development/app.md`)
124128

125129
#### Documentation generation (from `/package.json` and `/docs/development/frontend.md`):
126130
- **Generate API docs:** `npm run docs` (from `/package.json`, documented in `/docs/development/frontend.md`)
@@ -227,14 +231,25 @@ should NOT unless explicitly requested or strictly necessary for the change
227231
3. `npm run backend:test` (from `/package.json`, documented in `/docs/development/backend.md`)
228232
4. `npm run backend:format` (from `/package.json`, documented in `/docs/development/backend.md`)
229233

230-
#### Example 3: Documentation update
234+
#### Example 3: Desktop app code fix
235+
- **Files to change:** `app/electron/example.ts` (example path)
236+
- **Rationale:** Fix window management issue in Electron app
237+
- **Commands to validate:**
238+
1. `npm run app:install` (from `/package.json`)
239+
2. `npm run app:lint:fix` (from `/package.json`, documented in `/docs/development/app.md`)
240+
3. `npm run app:format` (from `/package.json`, documented in `/docs/development/app.md`)
241+
4. `npm run app:lint` (from `/package.json`, documented in `/docs/development/app.md`)
242+
5. `npm run app:tsc` (from `/package.json`, documented in `/docs/development/app.md`)
243+
6. `npm run app:test` (from `/package.json`, documented in `/docs/development/app.md`)
244+
245+
#### Example 4: Documentation update
231246
- **Files to change:** `docs/development/index.md` (from consulted files list)
232247
- **Rationale:** Clarify local dev startup steps to match current npm scripts
233248
- **Commands to validate:**
234249
- Run the documented commands exactly as written and confirm they succeed
235250
- For doc-only changes, testing commands is sufficient; no build needed
236251

237-
#### Example 4: Plugin development
252+
#### Example 5: Plugin development
238253
- **Files to change:** Plugin code in `/plugins/examples/` directory
239254
- **Rationale:** Add new plugin example
240255
- **Commands to validate:**
@@ -327,7 +342,8 @@ Reference: `/docs/contributing.md` and `/.github/pull_request_template.md`
327342
1. `/docs/development/index.md` - Primary development guide (lines 1-310)
328343
2. `/docs/development/frontend.md` - Frontend dev guide (lines 1-82)
329344
3. `/docs/development/backend.md` - Backend dev guide (lines 1-69)
330-
4. `/docs/development/testing.md` - Testing guide (lines 1-83)
345+
4. `/docs/development/app.md` - Desktop app dev guide
346+
5. `/docs/development/testing.md` - Testing guide (lines 1-83)
331347
5. `/docs/development/architecture.md` - System architecture
332348
6. `/docs/development/plugins/index.md` - Plugin system
333349
7. `/docs/development/plugins/building.md` - Building plugins

0 commit comments

Comments
 (0)