# AGENTS.md

Git with a cup of tea! Painless self-hosted all-in-one software development service, including Git hosting, code review, team collaboration, package registry and CI/CD

## Setup

```
pnpm install
```

## Commands

```
make help
make clean-all
make clean
make fmt
make fmt-check
make generate-swagger
```

## Layout

- `modules/`        1038 source files
- `services/`       500 source files
- `routers/`        462 source files
- `models/`         375 source files
- `modelmigration/` 340 source files
- `tests/`          289 source files

## Conventions

- Tests live alongside the code they cover, following `build/openapi3gen/convert_test.go`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- CI defines what passing means. See `.github/workflows/cache-prune.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Generated output is committed (`build/`). Search will return the compiled copy, so edit the source, not that.
- `modules/emoji/emoji_data.go` is 364KB. 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.