{"owner":"avelino","repo":"awesome-go","hasSkills":true,"hasMcp":false,"mcpConfig":null,"found":["AGENTS.md"],"skills":{"AGENTS.md":"# awesome-go · LLM Contribution Guide\n\nThis document summarizes the project context and the conventions that language models must follow when helping on this repository.\n\n## Project Snapshot\n\n- Purpose: maintain the curated `README.md` list of Go resources and generate the static site via `go run .`.\n- Primary language: Go 1.23 (see `go.mod`). Supporting JavaScript exists only for the GitHub Action in `.github/scripts`.\n- Key entry points:\n  - `main.go`: reads `README.md`, builds category pages, and writes artifacts to `out/` using templates in `tmpl/`.\n  - `pkg/markdown` and `pkg/slug`: helper packages used by the generator.\n  - `.github/workflows/`: CI pipelines for PR quality validation, stale checks, site deployment, and Go tests.\n\n## When Modifying the Awesome List\n\n- Read and respect `CONTRIBUTING.md` (alphabetical order, one item per PR, descriptions end with a period, etc.).\n- Keep categories with at least three entries and verify surrounding entries still meet quality standards.\n- Avoid promotional copy; descriptions must stay concise and neutral.\n- Do not drop existing content unless removal is requested and justified.\n\n## Coding Guidelines\n\n- Go:\n  - Use standard formatting (`gofmt`) and idiomatic Go style.\n  - Favor small, testable functions; keep exported APIs documented with Go-style comments.\n  - Maintain ≥80% coverage for non-data packages and ≥90% for data packages when adding new testable code.\n- JavaScript (GitHub Action script):\n  - Keep Node 20 compatibility.\n  - Uphold strict mode and existing patterns (async helpers, early returns, descriptive errors).\n- Generated site output is not committed; do not add files under `out/`.\n\n## Testing & Validation\n\n- Preferred commands before submitting Go changes:\n  - `go test ./...`\n  - `go test -run ^TestStaleRepository$` (mirrors the scheduled workflow focus).\n- For list-only modifications, run linting/formatting on touched files if tools are configured locally.\n- The `PR Quality Checks` workflow will run `.github/scripts/check-quality.js`; ensure referenced links in PR bodies are reachable.\n\n## CI Overview\n\n- `tests.yaml`: runs `go test main_test.go main.go` on pushes/PRs.\n- `pr-quality-check.yaml`: validates PR metadata (forge link, pkg.go.dev, Go Report Card, coverage).\n- `run-check.yaml`: scheduled stale repository audit via `go test -run ^TestStaleRepository$`.\n- `site-deploy.yaml`: builds and deploys the static site to Netlify on `main` pushes.\n\n## Documentation & Housekeeping\n\n- Update this `AGENTS.md` whenever repository conventions change.\n- Keep documentation in English; follow American English spelling for code and comments.\n- Remove unused files/modules when confirmed obsolete.\n- Align rendered documentation (`README.md`, `COVERAGE.md`, etc.) with any behavior changes made to `main.go` or helper packages.\n"},"files":{"AGENTS.md":"# awesome-go · LLM Contribution Guide\n\nThis document summarizes the project context and the conventions that language models must follow when helping on this repository.\n\n## Project Snapshot\n\n- Purpose: maintain the curated `README.md` list of Go resources and generate the static site via `go run .`.\n- Primary language: Go 1.23 (see `go.mod`). Supporting JavaScript exists only for the GitHub Action in `.github/scripts`.\n- Key entry points:\n  - `main.go`: reads `README.md`, builds category pages, and writes artifacts to `out/` using templates in `tmpl/`.\n  - `pkg/markdown` and `pkg/slug`: helper packages used by the generator.\n  - `.github/workflows/`: CI pipelines for PR quality validation, stale checks, site deployment, and Go tests.\n\n## When Modifying the Awesome List\n\n- Read and respect `CONTRIBUTING.md` (alphabetical order, one item per PR, descriptions end with a period, etc.).\n- Keep categories with at least three entries and verify surrounding entries still meet quality standards.\n- Avoid promotional copy; descriptions must stay concise and neutral.\n- Do not drop existing content unless removal is requested and justified.\n\n## Coding Guidelines\n\n- Go:\n  - Use standard formatting (`gofmt`) and idiomatic Go style.\n  - Favor small, testable functions; keep exported APIs documented with Go-style comments.\n  - Maintain ≥80% coverage for non-data packages and ≥90% for data packages when adding new testable code.\n- JavaScript (GitHub Action script):\n  - Keep Node 20 compatibility.\n  - Uphold strict mode and existing patterns (async helpers, early returns, descriptive errors).\n- Generated site output is not committed; do not add files under `out/`.\n\n## Testing & Validation\n\n- Preferred commands before submitting Go changes:\n  - `go test ./...`\n  - `go test -run ^TestStaleRepository$` (mirrors the scheduled workflow focus).\n- For list-only modifications, run linting/formatting on touched files if tools are configured locally.\n- The `PR Quality Checks` workflow will run `.github/scripts/check-quality.js`; ensure referenced links in PR bodies are reachable.\n\n## CI Overview\n\n- `tests.yaml`: runs `go test main_test.go main.go` on pushes/PRs.\n- `pr-quality-check.yaml`: validates PR metadata (forge link, pkg.go.dev, Go Report Card, coverage).\n- `run-check.yaml`: scheduled stale repository audit via `go test -run ^TestStaleRepository$`.\n- `site-deploy.yaml`: builds and deploys the static site to Netlify on `main` pushes.\n\n## Documentation & Housekeeping\n\n- Update this `AGENTS.md` whenever repository conventions change.\n- Keep documentation in English; follow American English spelling for code and comments.\n- Remove unused files/modules when confirmed obsolete.\n- Align rendered documentation (`README.md`, `COVERAGE.md`, etc.) with any behavior changes made to `main.go` or helper packages.\n"},"items":[{"name":"AGENTS.md","path":"AGENTS.md","title":"AGENTS.md","content":"# awesome-go · LLM Contribution Guide\n\nThis document summarizes the project context and the conventions that language models must follow when helping on this repository.\n\n## Project Snapshot\n\n- Purpose: maintain the curated `README.md` list of Go resources and generate the static site via `go run .`.\n- Primary language: Go 1.23 (see `go.mod`). Supporting JavaScript exists only for the GitHub Action in `.github/scripts`.\n- Key entry points:\n  - `main.go`: reads `README.md`, builds category pages, and writes artifacts to `out/` using templates in `tmpl/`.\n  - `pkg/markdown` and `pkg/slug`: helper packages used by the generator.\n  - `.github/workflows/`: CI pipelines for PR quality validation, stale checks, site deployment, and Go tests.\n\n## When Modifying the Awesome List\n\n- Read and respect `CONTRIBUTING.md` (alphabetical order, one item per PR, descriptions end with a period, etc.).\n- Keep categories with at least three entries and verify surrounding entries still meet quality standards.\n- Avoid promotional copy; descriptions must stay concise and neutral.\n- Do not drop existing content unless removal is requested and justified.\n\n## Coding Guidelines\n\n- Go:\n  - Use standard formatting (`gofmt`) and idiomatic Go style.\n  - Favor small, testable functions; keep exported APIs documented with Go-style comments.\n  - Maintain ≥80% coverage for non-data packages and ≥90% for data packages when adding new testable code.\n- JavaScript (GitHub Action script):\n  - Keep Node 20 compatibility.\n  - Uphold strict mode and existing patterns (async helpers, early returns, descriptive errors).\n- Generated site output is not committed; do not add files under `out/`.\n\n## Testing & Validation\n\n- Preferred commands before submitting Go changes:\n  - `go test ./...`\n  - `go test -run ^TestStaleRepository$` (mirrors the scheduled workflow focus).\n- For list-only modifications, run linting/formatting on touched files if tools are configured locally.\n- The `PR Quality Checks` workflow will run `.github/scripts/check-quality.js`; ensure referenced links in PR bodies are reachable.\n\n## CI Overview\n\n- `tests.yaml`: runs `go test main_test.go main.go` on pushes/PRs.\n- `pr-quality-check.yaml`: validates PR metadata (forge link, pkg.go.dev, Go Report Card, coverage).\n- `run-check.yaml`: scheduled stale repository audit via `go test -run ^TestStaleRepository$`.\n- `site-deploy.yaml`: builds and deploys the static site to Netlify on `main` pushes.\n\n## Documentation & Housekeeping\n\n- Update this `AGENTS.md` whenever repository conventions change.\n- Keep documentation in English; follow American English spelling for code and comments.\n- Remove unused files/modules when confirmed obsolete.\n- Align rendered documentation (`README.md`, `COVERAGE.md`, etc.) with any behavior changes made to `main.go` or helper packages.\n","category":"root","tokens":708}]}