From d814d2d6844f992c5fecaca7b2115de4b4c41655 Mon Sep 17 00:00:00 2001 From: Napas Udomsak <14320466+tian000@users.noreply.github.com> Date: Tue, 18 Aug 2026 17:37:20 +0000 Subject: [PATCH] docs: add agent instruction entrypoints Co-authored-by: casper-phantom <273411261+phantom-autopilot@users.noreply.github.com> --- AGENTS.md | 29 +++++++++++++++++++++++++++++ CLAUDE.md | 1 + 2 files changed, 30 insertions(+) create mode 100644 AGENTS.md create mode 120000 CLAUDE.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 000000000..6f10a2f50 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,29 @@ +# Repository Instructions + +## Purpose + +This repository is Phantom's fork of `react-native-webview`, a community-maintained WebView component for React Native. It supports iOS, Android, Windows, macOS, and both React Native architectures. + +## Layout + +- `src/`: TypeScript and React Native component source. +- `android/`, `apple/`, `ios/`, `macos/`, `windows/`: platform-specific native implementations. +- `example/`: example and native test applications. +- `__tests__/` and `jest-setups/`: Jest tests and setup. +- `docs/`: usage, API, and contribution documentation. + +## Commands + +Install dependencies with `yarn install` (CI uses `yarn --frozen-lockfile`). + +- `yarn ci`: run the TypeScript and ESLint checks used by the repository's CI script. +- `yarn lint`: run TypeScript checking and ESLint directly. +- `yarn build`: compile `src/` into `lib/` with Babel. +- `yarn android`, `yarn ios`, `yarn macos`, `yarn windows`: build and run the corresponding example application; follow `docs/Contributing.md` for platform prerequisites. +- `yarn test:windows`: run the configured Windows Jest suite. + +## Contribution Constraints + +- Use TypeScript for JavaScript-layer source changes. +- Test platform changes through the relevant example application as described in `docs/Contributing.md`. +- Follow `VERSIONING.md` and add a Changesets entry for publishable package changes. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 120000 index 000000000..47dc3e3d8 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +AGENTS.md \ No newline at end of file