From 36b3b59b2bd48730256a2866a4d895618a145517 Mon Sep 17 00:00:00 2001
From: Sagar-Kap <69609200+Sagar-Kap@users.noreply.github.com>
Date: Fri, 7 Aug 2026 11:19:43 +0300
Subject: [PATCH] docs: add repository instructions (AGENTS.md)

---
 AGENTS.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 AGENTS.md

diff --git a/AGENTS.md b/AGENTS.md
new file mode 100644
index 0000000..b4a4268
--- /dev/null
+++ b/AGENTS.md
@@ -0,0 +1,54 @@
+# @weburz/carousel — repository instructions
+
+Nuxt 4 module: carousel components for YouTube, Instagram, and TikTok embeds
+built on Embla. Three platform wrappers (`YouTubeCarousel`, `TikTokCarousel`,
+`InstagramCarousel`) share one `BaseCarousel`/`BaseSlide` core.
+
+## Commands (pnpm, never npm/yarn)
+
+- `pnpm test` — Vitest suite (module `test/`, fixture `test/fixtures/basic`).
+- `pnpm lint` — ESLint flat config (`eslint.config.mjs`).
+- `pnpm test:types` — `vue-tsc --noEmit` on the module + playground.
+- `pnpm dev:prepare` — regenerate `.nuxt`/`dist` stub types. **Run this before
+  `pnpm test:types`** on a fresh checkout: the root tsconfig extends the
+  generated `.nuxt/tsconfig.json`, and a stale one produces false type errors.
+- `pnpm dev` — run the playground.
+
+### pnpm 11 notes
+
+- `allowBuilds:` lives in `pnpm-workspace.yaml` (esbuild, @parcel/watcher,
+  unrs-resolver). Only that file is honored — not `package.json` keys.
+- CI runs `pnpm install --frozen-lockfile`; a lockfile pinning packages under
+  the `minimumReleaseAge` window fails with
+  `ERR_PNPM_MINIMUM_RELEASE_AGE_VIOLATION` (dependabot's aggregate PRs hit this
+  when resolving brand-new transitive releases). Wait for the window or bump
+  individual packages via their own dependabot PRs.
+
+## Conventions
+
+- **Stateless components**: no internal hardcoded state. Platform wrappers
+  receive data via props and emit events; `BaseCarousel`/`BaseSlide` own the
+  layout/sizing but no business state. Reuse the facade/iframe composables in
+  `src/runtime/composables/` instead of re-implementing embed lifecycles.
+- **Arrow functions only**; composables are named `useAdjectiveX`
+  (`useFacadeActivation`), never `useVerbX`.
+- **`Intl.DateTimeFormat`** instantiated once and reused — never repeated
+  `toLocaleDateString()`.
+- **Widen contracts, don't coerce**: keep `SlidesPerView` and shared props
+  (options/plugins/slidesPerView/layout/…) compound in
+  `src/runtime/types.ts`; extend them, don't redeclare per component.
+- No token auth/tracking params leak into embed URLs; keep the query-stripping
+  and keyless-thumbnail behavior intact when touching `buildEmbedUrl` or
+  thumbnail fallbacks.
+
+## Testing process
+
+TDD red → green → refactor. Unit-test pure runtime helpers (embed URL
+building, slides CSS, facade/iframe parking) in `test/*.test.ts` without
+network or DOM browser mocking; the fixture SSR suite covers the rendered
+components.
+
+## Dev flow
+
+Push feature branches and open PRs; no Plane. Do not attribute code to AI in
+commits, PRs, or comments.