# AGENTS.md

A platform for community discussion. Free, open, simple.

## Setup

```
pnpm install
```

## Commands

```
pnpm dev            # run locally
pnpm start          # run the app
pnpm build          # produce a build
pnpm lint           # lint
pnpm lint:fix
pnpm lint:css
pnpm lint:css:fix
pnpm lint:js
```

## Layout

- `plugins/`  5389 source files
- `frontend/` 2186 source files
- `spec/`     2147 source files
- `db/`       1788 source files
- `app/`      1248 source files
- `lib/`      733 source files

## Conventions

- Tests live alongside the code they cover, following `app/controllers/test_requests_controller.rb`.
- TypeScript is not in strict mode. Turning it on catches a whole class of mistakes before they run.
- CI defines what passing means. See `.github/workflows/backport.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `plugins/discourse-graphviz/public/javascripts/viz-3.0.1.js` is 2085KB. 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.