# AGENTS.md

Material UI: Comprehensive React component library that implements Google's Material Design. Free forever.

## Setup

```
pnpm install
```

## Commands

```
pnpm start          # run the app
pnpm build          # produce a build
pnpm test           # run the test suite, must pass before any commit
pnpm preinstall
pnpm proptypes
pnpm deduplicate
pnpm build:ci
pnpm build:public
```

## Layout

- `packages/`          24618 source files
- `docs/`              2396 source files
- `packages-internal/` 375 source files
- `test/`              149 source files
- `examples/`          120 source files
- `scripts/`           10 source files

## Conventions

- Tests live alongside the code they cover, following `docs/pages/experiments/website/branding-theme-test.tsx`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- CI defines what passing means. See `.github/workflows/check-if-pr-has-label.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `packages/mui-icons-material/lib/index.js` is 2309KB. 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.