# AGENTS.md

Run your GitHub Actions locally 🚀

## Setup

```
go mod download
```

## Commands

```
make pr
make build        # produce a build
make format       # format
make format-all
make test         # run the test suite, must pass before any commit
make lint-go
```

## Layout

- `pkg/` 1221 source files
- `cmd/` 10 source files

## Conventions

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

## Gotchas

- `pkg/runner/testdata/actions/node20/node_modules/@octokit/openapi-types/types.d.ts` is 4642KB. 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.