# AGENTS.md

Distributed reliable key-value store for the most critical data of a distributed system

## Setup

```
go mod download
```

## Commands

```
make build               # produce a build
make install-benchmark
make bench-put
make build-all
make tools
make test                # run the test suite, must pass before any commit
```

## Layout

- `server/`  383 source files
- `tests/`   272 source files
- `client/`  195 source files
- `pkg/`     88 source files
- `tools/`   62 source files
- `etcdctl/` 42 source files

## Conventions

- Tests live alongside the code they cover, following `.github/workflows/antithesis-test.yml`.
- CI defines what passing means. See `.github/workflows/antithesis-test.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `api/etcdserverpb/gw/rpc.pb.gw.go` is 167KB. 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.