From d3e0718d147ea9d95a27a715d81418b9e6a4ac94 Mon Sep 17 00:00:00 2001 From: fullsend-code <278716306+fullsend-ai-coder[bot]@users.noreply.github.com> Date: Tue, 28 Jul 2026 09:18:46 +0000 Subject: [PATCH] docs(#4025): add build commands and import conventions to boost AGENTS.md Add two new sections to the boost workspace AGENTS.md to prevent recurring CI failures and convention violations in agent-generated PRs: - Build & verify: command table covering build, type-check, lint, test, API reports, and OpenSpec validation. Includes guidance to run yarn build:api-reports after modifying API surface files. - Import conventions: documents @remixicon/react as the standard icon library (not @mui/icons-material) and .toLowerCase() normalization for spec.type comparisons. These gaps caused preventable failures on PR #3747: a missing report.api.md regeneration, wrong icon library imports after merge, and case-sensitive specType comparisons. Closes #4025 --- workspaces/boost/AGENTS.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/workspaces/boost/AGENTS.md b/workspaces/boost/AGENTS.md index 2b431c2917..bfcba06190 100644 --- a/workspaces/boost/AGENTS.md +++ b/workspaces/boost/AGENTS.md @@ -105,6 +105,28 @@ Every feature ships with tests. Integration tests use real database and cache ba - WCAG 2.1 AA accessibility - Feature flags via `boost.features.*` in `app-config.yaml` +## Build & verify + +| Task | Command | +| --- | --- | +| Full build | `yarn build:all` | +| Type-check | `yarn tsc:full` | +| Lint | `yarn lint:all` | +| Test | `CI=true yarn test --watchAll=false` | +| API reports | `yarn build:api-reports` | +| OpenSpec validation | `yarn openspec:validate` | + +**After modifying any file that affects the public API surface** (including +`translations/ref.ts`, exported types, or API routes), run +`yarn build:api-reports` and commit the updated `report.api.md`. + +## Import conventions + +- **Icons**: use `@remixicon/react` (e.g., `RiCheckLine`, `RiDownload2Line`). + Do NOT use `@mui/icons-material` — the plugin migrated in PR #3929. +- **Entity type comparisons**: always normalize with `.toLowerCase()` before + comparing `spec.type` values (see `isAiAsset.ts`, `categoryMeta.ts`). + ## What not to do - Do not reference the `workspaces/augment/` codebase for implementation patterns — boost is a clean-room build