Skip to content

docs: add agent instruction entrypoints #5

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 #5

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
22 changes: 22 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Repository instructions

## Purpose
This repository contains Phantom's `@phantom/react-native-fast-image` package, a performant React Native image component backed by SDWebImage on iOS and Glide on Android.

## Layout
- `src/`: JavaScript and TypeScript package source.
- `ios/`: native iOS implementation.
- `android/`: native Android implementation.
- `ReactNativeFastImageExample/`: React Native example app used for manual development.
- `ReactNativeFastImageExampleServer/`: server used by the example project.
- `docs/`: development and troubleshooting documentation.

## Development and validation
Use Yarn v1 and keep `yarn.lock` in sync with dependency changes.

- Install dependencies: `yarn --frozen-lockfile`
- Build the package: `yarn build`
- Run tests with coverage: `yarn test --coverage`
- Run the configured linter: `yarn lint`

To exercise native changes, follow `docs/development.md` to link the package into `ReactNativeFastImageExample/`, start Metro, and run the iOS or Android app. This project targets the latest React Native version rather than backporting new features to older releases.
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