AGENTS.md

1# awesome-go · LLM Contribution Guide
2 
3This document summarizes the project context and the conventions that language models must follow when helping on this repository.
4 
5## Project Snapshot
6 
7- Purpose: maintain the curated `README.md` list of Go resources and generate the static site via `go run .`.
8- Primary language: Go 1.23 (see `go.mod`). Supporting JavaScript exists only for the GitHub Action in `.github/scripts`.
9- Key entry points:
10  - `main.go`: reads `README.md`, builds category pages, and writes artifacts to `out/` using templates in `tmpl/`.
11  - `pkg/markdown` and `pkg/slug`: helper packages used by the generator.
12  - `.github/workflows/`: CI pipelines for PR quality validation, stale checks, site deployment, and Go tests.
13 
14## When Modifying the Awesome List
15 
16- Read and respect `CONTRIBUTING.md` (alphabetical order, one item per PR, descriptions end with a period, etc.).
17- Keep categories with at least three entries and verify surrounding entries still meet quality standards.
18- Avoid promotional copy; descriptions must stay concise and neutral.
19- Do not drop existing content unless removal is requested and justified.
20 
21## Coding Guidelines
22 
23- Go:
24  - Use standard formatting (`gofmt`) and idiomatic Go style.
25  - Favor small, testable functions; keep exported APIs documented with Go-style comments.
26  - Maintain ≥80% coverage for non-data packages and ≥90% for data packages when adding new testable code.
27- JavaScript (GitHub Action script):
28  - Keep Node 20 compatibility.
29  - Uphold strict mode and existing patterns (async helpers, early returns, descriptive errors).
30- Generated site output is not committed; do not add files under `out/`.
31 
32## Testing & Validation
33 
34- Preferred commands before submitting Go changes:
35  - `go test ./...`
36  - `go test -run ^TestStaleRepository$` (mirrors the scheduled workflow focus).
37- For list-only modifications, run linting/formatting on touched files if tools are configured locally.
38- The `PR Quality Checks` workflow will run `.github/scripts/check-quality.js`; ensure referenced links in PR bodies are reachable.
39 
40## CI Overview
41 
42- `tests.yaml`: runs `go test main_test.go main.go` on pushes/PRs.
43- `pr-quality-check.yaml`: validates PR metadata (forge link, pkg.go.dev, Go Report Card, coverage).
44- `run-check.yaml`: scheduled stale repository audit via `go test -run ^TestStaleRepository$`.
45- `site-deploy.yaml`: builds and deploys the static site to Netlify on `main` pushes.
46 
47## Documentation & Housekeeping
48 
49- Update this `AGENTS.md` whenever repository conventions change.
50- Keep documentation in English; follow American English spelling for code and comments.
51- Remove unused files/modules when confirmed obsolete.
52- Align rendered documentation (`README.md`, `COVERAGE.md`, etc.) with any behavior changes made to `main.go` or helper packages.
53