# AGENTS.md

A cloud-native Go microservices framework with cli tool for productivity.

## Setup

```
go mod download
```

## Commands

```
go test ./...   # run the test suite
```

## Layout

- `core/`     474 source files
- `tools/`    393 source files
- `rest/`     83 source files
- `zrpc/`     80 source files
- `gateway/`  13 source files
- `internal/` 11 source files

## Conventions

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

## Gotchas

- `core/mapping/unmarshaler_test.go` is 134KB. 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.