iptvnator/docs/development/agent-workflow.md

Agent development workflow

Common startup rules live in AGENTS.md. This document holds procedures and conventions to read when they apply, not extra startup imports.

Maintaining canonical knowledge

After meaningful changes, assess documentation before declaring completion. Meaningful changes include user-visible behavior, architecture/data flow, maintenance/setup/debugging workflows, and subsystem contracts. Formatting, behavior-preserving refactors and isolated test changes need no doc update. Prefer the existing authoritative architecture doc or nearest module README; README.md owns top-level user/developer entry points. Update stale routes, paths, commands and contracts you encounter, or explicitly flag unresolved claims in the final summary. Repo docs remain canonical regardless of authorship.

Keep AGENTS.md limited to repository-wide constraints and task routing. Do not add feature histories, method lists, schema inventories or troubleshooting procedures to it. CLAUDE.md imports AGENTS.md; do not mirror common prose by hand. Use the context map for the owning document and relevant skill. Read multiple contracts for cross-domain work. Add a new canonical document only when no existing owner fits; link it from the map.

When relocating knowledge, compare both sources and the destination, retain unique exceptions and rationale, and record corrections with code evidence. The 2026-09 migration ledger records the initial move; it is an audit artifact, not required reading for feature work. Later normal edits maintain the canonical docs, not duplicate historical prose.

Run pnpm run agents:validate after guidance changes. It checks line/byte budgets, root imports and local navigation links/anchors, including migration destinations. Markdown navigation is parsed with the already-declared marked dependency; undefined explicit reference links are errors, and code examples are excluded. Heading anchors are derived from parsed text, not HTML sanitization. The Nx test hash includes marked so dependency changes invalidate parser coverage. It cannot prove semantic equivalence; review changed contracts as well.

Protected Markdown edits

Never run whole-file prettier --write on AGENTS.md, CLAUDE.md or docs/**. Upstream formatting is not uniformly Prettier-clean: whole-file writes can corrupt nested list indentation or change a literal continuation into a bullet. Format only intended new lines. If accidental formatting occurred, reconstruct from the pre-edit version and reapply only intended changes; preserve unrelated user edits. Use the merge-base version only if it actually represents that pre-edit state. Review the diff rather than blindly restoring an older branch.

Plans and completion reports

Save only finalized plans in .plans/YYYY-MM-DD-short-topic.md; use numeric suffixes for collisions. Do not save drafts or questions there. If an active mode forbids writes, save the approved plan on entering execution. Completion reports list changed docs, tests added/updated, commands and results, skipped validation with reasons, and release-note status. A docs-only task needs Markdown/link validation, not app unit/E2E tests. Tooling changes need their own tests.

Repository skills

Repository skills live under .codex/skills/. Descriptions are trigger-only, begin with Use when, and each skill is at most 500 words. Frontmatter owns trigger descriptions; avoid copying them into navigation prose. Skills provide workflow and links to authoritative contracts, not a second contract copy. release-cut and release-notes have byte-identical .claude/skills/ mirrors. Run pnpm run skills:validate after changing a committed skill or a literal path it documents. New guidance tooling belongs to the existing repository-skills Nx project; no new project is needed for another validator.

Angular conventions

Use signal-based queries (viewChild, viewChildren, contentChild, contentChildren) and inputs/outputs (input, output). For required queries, use viewChild.required. Unwrap signals when passing values in templates:

readonly menu = viewChild.required<MatMenu>('menuRef');
readonly title = input.required<string>();
readonly size = input<number>(10);
readonly clicked = output<void>();
readonly count = signal(0);
readonly doubled = computed(() => this.count() * 2);

<button [matMenuTriggerFor]="menu()">Open Menu</button>

Use signal, computed, effect and linkedSignal for reactive state. Existing host bindings/listeners use @HostBinding and @HostListener; this relocation does not change that convention. Prefer @if, @for (with a stable track), and @switch over the legacy structural directives. A signal is a function; passing menu instead of menu() to Material supplies the wrong value.

Adding behavior across layers

For IPC, define the handler in the appropriate Electron events module, register it in the event bootstrap, expose a typed preload method, and consume it through the renderer service. Keep channel contracts typed in ElectronBridgeApi; use the database worker contract for heavy database work. See Electron security and DB worker ownership.

For a playlist source, extend the shared playlist type, add the backend event handler, add the import UI under libs/playlist/import/feature, and update state actions/effects. Preserve runtime capabilities and migration behavior. NgRx owns M3U global state; portal/feature state uses composed NgRx Signal Store; component-local state uses Angular signals. Avoid expanding large classes: extract components/services or with* store features before exceeding limits; shared types belong in their own contract modules. The hard production limit is 400 (not a variable 350–400); target under 300. See Nx file-size policy.

Build and serve commands

Use local pnpm nx for underlying project targets. Package scripts are the supported entry points for composed tasks:

Task	Command
Web development	pnpm run serve:frontend
PWA development	pnpm nx serve web --configuration=pwa
Electron development	pnpm run serve:backend
Electron frontend	pnpm run build:frontend
PWA frontend	pnpm run build:frontend:pwa
Electron backend	pnpm run build:backend
Package without installers	pnpm run package:app
Create installers	pnpm run make:app

Electron backend build depends on the web build; outputs live under dist/apps/electron-backend and dist/apps/web and packaging combines them. Use the validation map for test/lint tasks and the release pipeline for packaging.