# AGENTS.md

The fantastic ORM library for Golang, aims to be developer friendly

## Setup

```
go mod download
```

## Commands

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

## Layout

- `tests/`     57 source files
- `clause/`    36 source files
- `schema/`    21 source files
- `callbacks/` 15 source files
- `utils/`     7 source files
- `logger/`    5 source files

## Conventions

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

---

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.