AGENTS.md · avelino/awesome-go

Sections

1. Project Snapshot
2. When Modifying the Awesome List
3. Coding Guidelines
4. Testing & Validation
5. CI Overview
6. Documentation & Housekeeping

First lines (shown under the repo's MIT license)

# awesome-go · LLM Contribution Guide

This document summarizes the project context and the conventions that language models must follow when helping on this repository.

## Project Snapshot

- Purpose: maintain the curated `README.md` list of Go resources and generate the static site via `go run .`.
- Primary language: Go 1.26 (`go 1.26.0` in `go.mod`, toolchain `go1.27.3`). Supporting JavaScript exists only for the GitHub Action in `.github/scripts`.
- Key entry points:
  - `main.go`: reads `README.md`, builds category pages, and writes artifacts to `out/` using templates in `tmpl/`.
  - `pkg/markdown` and `pkg/slug`: helper packages used by the generator.
  - `.github/workflows/`: CI pipelines for PR quality validation, stale checks, site deployment, and Go tests.

## When Modifying the Awesome List

- Read and respect `CONTRIBUTING.md` (alphabetical order, one item per PR, descriptions end with a period, etc.).
- Keep categories with at least three entries and verify surrounding entries still meet quality standards.
- Avoid promotional copy; descriptions must stay concise and neutral.
- Do not drop existing content unless removal is requested and justified.

## Coding Guidelines

- Go:
  - Use standard formatting (`gofmt`) and idiomatic Go style.
  - Favor small, testable functions; keep exported APIs documented with Go-style comments.
  - Maintain ≥80% coverage for non-data packages and ≥90% for data packages when adding new testable code.
- JavaScript (GitHub Action script):
  - Keep Node 20 compatibility.
  - Uphold strict mode and existing patterns (async helpers, early returns, descriptive errors).
- Generated site output is not committed; do not add files under `out/`.

## Testing & Validation

- Preferred commands before submitting Go changes:
  - `go test ./...`
  - `go test -run ^TestStaleRepository$` (mirrors the scheduled workflow focus).
- For list-only modifications, run linting/formatting on touched files if tools are configured locally.
- The `PR Quality Checks` workflow will run `.github/scripts/check-quality.js`; ensure referenced links in PR bodies are reachable.

## CI Overview

- `tests.yaml`: runs `go test main_test.go main.go` on pushes/PRs. The job uses the `golang:1.27.3` container.
- `pr-quality-check.yaml`: validates PR metadata (forge link, pkg.go.dev, coverage). `.github/scripts/detect-pr-type` reads the README.md diff and only runs the checks when the PR adds a new link; removal-only and formatting-only changes skip them. The detect and quality jobs use the `golang:1.27.3` container.
- `run-check.yaml`: scheduled stale repository audit via `go test -run ^TestStaleRepository$`. The job uses the `golang:1.27.3` container.
- `site-deploy.yaml`: builds and deploys the static site to Netlify on `main` pushes. The job uses the `golang:1.27.3` container.
- Third-party actions are pinned to a full commit SHA. `.github/dependabot.yml` opens grouped weekly pull requests for `github-actions` and `gomod`.

## Documentation & Housekeeping

- Update this `AGENTS.md` whenever repository conventions change.
- Keep documentation in English; follow American English spelling for code and comments.
- Remove unused files/modules when confirmed obsolete.
- Align rendered documentation (`README.md`, `COVERAGE.md`, etc.) with any behavior changes made to `main.go` or helper packages.