# AGENTS.md

uBlock Origin - An efficient blocker for Chromium and Firefox. Fast and lean.

## Setup

```
npm ci
```

## Commands

```
npm run test   # run the test suite, must pass before any commit
npm run lint   # lint
```

## Layout

- `src/`      186 source files
- `platform/` 99 source files
- `tools/`    18 source files
- `docs/`     1 source file

## Conventions

- Tests live alongside the code they cover, following `docs/tests/css-selector-based-cosmetic-filters.html`.
- CI defines what passing means. See `.github/workflows/main.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Generated output is committed (`dist/`). Search will return the compiled copy, so edit the source, not that.
- `docs/tests/hostname-pool.js` is 1374KB. 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.