# AGENTS.md

A framework for building native applications using React

## Setup

```
yarn install
```

## Commands

```
yarn start           # run the app
yarn build           # produce a build
yarn test            # run the test suite, must pass before any commit
yarn lint            # lint
yarn format          # format
yarn android
yarn build-android
yarn build-types
```

## Layout

- `packages/`   5145 source files
- `scripts/`    326 source files
- `private/`    156 source files
- `flow-typed/` 47 source files
- `jest/`       1 source file

## Conventions

- Tests live alongside the code they cover, following `.github/workflow-scripts/__tests__/createDraftRelease-test.js`.
- CI defines what passing means. See `.github/workflows/analyze-pr.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `packages/react-native/Libraries/Renderer/implementations/ReactFabric-dev.js` is 708KB. It will not fit comfortably in context, so read it in parts.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.