Skip to content

docs: add agent instruction entrypoints #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
casper-phantom wants to merge 1 commit into from
Closed

docs: add agent instruction entrypoints #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
AGENTS.md
Loading