Skip to content

Commit ef2cb24

Browse files
committed
docs: add CI checks section to AGENTS.md
1 parent d266fad commit ef2cb24

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

AGENTS.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,20 @@ docker run --rm -v $(pwd):/app -w /app golang:1.24 go test -v -race ./...
3535

3636
Note: Race detector requires CGO, which is not available in alpine images. The Dockerfile test stage uses the full golang image for this reason.
3737

38+
## CI Checks
39+
40+
Run the full CI suite locally before committing:
41+
42+
```bash
43+
# Run all CI checks (format, vet, test with race detector)
44+
docker run --rm -v $(pwd):/app -w /app golang:1.24 sh -c "go fmt ./... && go vet ./... && go test -v -race ./..."
45+
```
46+
47+
The CI pipeline runs:
48+
1. **Format check**: `go fmt ./...` followed by `git diff --exit-code` (fails if formatting changes files)
49+
2. **Vet**: `go vet ./...`
50+
3. **Test**: `go test -v -race ./...`
51+
3852
## Code Style
3953

4054
- Run `go fmt` on all code before committing

0 commit comments

Comments
 (0)