# AGENTS.md

开放式跨端跨框架解决方案，支持使用 React/Vue 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。

## Setup

```
pnpm install
```

## Commands

```
pnpm build                 # produce a build
pnpm test                  # run the test suite, must pass before any commit
pnpm lint                  # lint
pnpm format                # format
pnpm preinstall
pnpm prepare
pnpm build:serial
pnpm build:binding:debug
```

## Layout

- `packages/` 2876 source files
- `examples/` 569 source files
- `tests/`    157 source files
- `crates/`   117 source files
- `scripts/`  2 source files

## Conventions

- Tests live alongside the code they cover, following `crates/native_binding/__test__/index.spec.mjs`.
- CI defines what passing means. See `.github/workflows/auto-review.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `packages/taro-cli-convertor/report/static/js/bundle.js` is 1967KB. 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.