# AGENTS.md

🌴 Empowering everyone to build reliable and efficient smart contracts.

## Setup

```
cargo build
```

## Commands

```
cargo test   # run the test suite
```

## Layout

- `sway-core/`    256 source files
- `forc-plugins/` 79 source files
- `sway-lsp/`     74 source files
- `swayfmt/`      71 source files
- `test/`         59 source files
- `sway-ir/`      47 source files

## Conventions

- Tests live alongside the code they cover, following `docs/book/src/forc/commands/forc_test.md`.
- CI defines what passing means. See `.github/workflows/benchmark.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `sway-core/src/ir_generation/function.rs` is 248KB. 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.