Skip to content

Commit b427dc7

Browse files
authored
docs: update agents files (#930)
1 parent d0cae98 commit b427dc7

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

AGENTS.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,19 @@
2525
- Place unit specs alongside code as `*.spec.ts[x]`; run them with `pnpm test:unit`. Reuse helpers in `src/lib` so fixtures stay deterministic and reset timers, TanStack Query caches, and mocks in `beforeEach`.
2626
- Reserve Playwright (`pnpm test:e2e`) for end-to-end flows and smoke coverage; keep component snapshots and accessibility assertions in Vitest using `@testing-library/react`.
2727

28+
## Scope Guardrails
29+
30+
- **Workspace-level resources only:** This repo implements workspace-level service accounts. User-level API keys are out of scope.
31+
- **Icons:** Reuse existing icon components; **do not** import from `lucide-react` (AI tools default to this incorrectly).
32+
33+
## Common Implementation Patterns
34+
35+
- Reference similar existing features when implementing new ones (check zenml-cloud-ui repo for shared patterns)
36+
- **One-time secrets**: Display token/key once after creation in a dialog, never persist in UI state
37+
- **Query invalidation**: After mutations (create/update/delete), invalidate TanStack Query cache to refetch data
38+
- **Component reuse**: Check `src/components/` for existing patterns before creating new components
39+
- **Type safety**: Use generated types from `src/types/core.ts`, avoid `type any`
40+
2841
## Commit & Pull Request Guidelines
2942

3043
- Follow Conventional Commit prefixes (`feat:`, `fix:`, `chore:`) with ≤72-character subjects and include issue references (`#123`) when relevant.

CLAUDE.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,24 @@ Vite build is configured to split chunks by library:
212212
2. **Bundle size:** Build files are bundled into the Python package, so bundle size matters
213213
3. **No standalone use:** This dashboard is designed to work with the ZenML Server backend
214214
4. **Backwards compatibility:** Consider that users may be running different ZenML Server versions
215+
5. **Scope: Workspace-level resources only:** This dashboard implements workspace-level service accounts. User-level API keys are out of scope for this repository.
216+
217+
## Working with AI Coding Assistants
218+
219+
When using AI tools with this codebase:
220+
221+
### Provide Context
222+
223+
1. Reference existing implementations for similar features
224+
2. Point to the data fetching patterns in `src/data/`
225+
3. Note that many patterns are shared with zenml-cloud-ui (check that repo for reference implementations)
226+
227+
### Common Patterns
228+
229+
- **One-time secrets**: Display token/key once after creation, never show again
230+
- **Query invalidation**: After mutations, invalidate related TanStack Query queries to trigger refetch
231+
- **Component reuse**: Check `src/components/` before creating new components
232+
- **Type safety**: Use generated types from `src/types/core.ts`, avoid `type any`
215233

216234
## Common Patterns
217235

0 commit comments

Comments
 (0)