chore: AGENTS.md

Author: mdjastrzebski

AGENTS.md

@@ -0,0 +1,18 @@
+# Repository Guidelines
+
+This repository contains runnable examples for the Reassure performance testing library.
+
+Use Yarn, not npm. The root uses `yarn@4.6.0`; individual examples currently use `yarn@4.9.2`.
+
+Active code lives under `examples/`. Run installs, tests, typechecks, builds, and app commands from the specific example directory you changed because scripts and dependency versions are isolated per app.
+
+Non-standard validation to remember: `yarn perf-test` runs Reassure performance tests in examples that define it.
+
+See the focused guides before making task-specific changes:
+
+- [Project Structure](docs/agents/project-structure.md)
+- [Commands](docs/agents/commands.md)
+- [Coding Style](docs/agents/coding-style.md)
+- [Testing](docs/agents/testing.md)
+- [Git Workflow](docs/agents/git-workflow.md)
+- [Instruction Audit](docs/agents/instruction-audit.md)

CLAUDE.md

@@ -0,0 +1 @@
+For this repository, use AGENTS.md as the canonical agent guide. Read AGENTS.md first for compatibility.

docs/agents/coding-style.md

@@ -0,0 +1,18 @@
+# Coding Style
+
+Use TypeScript and React function components for new example code.
+
+Follow the root formatting configuration:
+
+- two-space indentation
+- LF line endings
+- UTF-8
+- final newline
+- trimmed trailing whitespace
+- single quotes
+- ES5 trailing commas
+- 120-column Prettier width
+
+Name component files with PascalCase when they export a component, such as `TestList.tsx`.
+
+Keep example code idiomatic to its framework. Do not introduce shared abstractions across examples unless the task explicitly requires cross-example behavior.

docs/agents/commands.md

@@ -0,0 +1,22 @@
+# Commands
+
+Install dependencies from the target example directory:
+
+```sh
+cd examples/web-vite
+yarn install
+```
+
+Common scripts vary by example:
+
+- `yarn test`: run Jest tests.
+- `yarn perf-test`: run Reassure performance tests where configured.
+- `yarn typecheck`: run TypeScript checks where configured.
+- `yarn lint`: run ESLint in examples that define it.
+- `yarn dev`: start Vite or Next.js development servers.
+- `yarn preview`: preview the Vite production build.
+- `yarn build`: build web examples that define a build script.
+- `yarn start`: start Expo, React Native Metro, or Next.js production server depending on the example.
+- `yarn ios`, `yarn android`, `yarn web`: run Expo or React Native examples on the selected platform.
+
+Validate only the relevant example unless the change intentionally affects multiple examples.

docs/agents/git-workflow.md

@@ -0,0 +1,17 @@
+# Git Workflow
+
+Recent history uses short imperative commit subjects, often with `chore:` for maintenance, for example:
+
+```text
+chore: upgrade web-vite example
+```
+
+Keep commits focused on one example or one cross-example concern.
+
+Pull requests should include:
+
+- the example or examples changed
+- validation commands run
+- related issues when available
+- screenshots for visible UI changes
+- native setup or platform-specific follow-up for iOS or Android changes

docs/agents/instruction-audit.md

@@ -0,0 +1,30 @@
+# Instruction Audit
+
+## Contradictions
+
+No contradictions were found in the previous root `AGENTS.md`.
+
+## Suggested Docs Folder Structure
+
+```text
+docs/
+  agents/
+    project-structure.md
+    commands.md
+    coding-style.md
+    testing.md
+    git-workflow.md
+    instruction-audit.md
+```
+
+## Flagged For Deletion
+
+These instructions were removed from the root file because they are better discovered progressively:
+
+- Full example directory descriptions: useful only when changing project structure or choosing an example.
+- Complete command list: useful only when running or validating an example.
+- Detailed formatting settings: useful only when editing code.
+- Test naming details: useful only when adding or reviewing tests.
+- Pull request checklist: useful only when preparing contribution metadata.
+
+No previous instruction was deleted as contradictory, too vague, or overly obvious.

docs/agents/project-structure.md

@@ -0,0 +1,12 @@
+# Project Structure
+
+The root `package.json` defines workspace metadata only. Make application changes in the relevant example directory.
+
+- `examples/native-cli`: React Native CLI app with Android and iOS native projects.
+- `examples/native-expo`: Expo React Native app.
+- `examples/web-vite`: React web app built with Vite.
+- `examples/web-nextjs`: React web app built with Next.js.
+
+Example source files are usually in `src/`, except app entry files such as `App.tsx`, `index.js`, and Next.js `src/app/*`.
+
+Static assets live in each app's `public/`, `src/assets/`, or native asset folders.

docs/agents/testing.md

@@ -0,0 +1,20 @@
+# Testing
+
+Jest is the unit test runner across examples.
+
+Testing libraries differ by platform:
+
+- React web examples use React Testing Library.
+- React Native examples use React Native Testing Library.
+
+Use these naming patterns:
+
+- `*.test.tsx` for unit and behavior tests.
+- `*.perf.tsx` for Reassure performance tests.
+
+Add or update unit tests for behavior changes. Add or update performance tests when changing measured rendering paths. When touching measured components, run both:
+
+```sh
+yarn test
+yarn perf-test
+```