Add AGENTS.md and golangci-lint Make target#1429
Merged
Merged
Conversation
Coding agents (Claude Code, etc.) repeatedly need the same orientation when starting work in this repo: which Make targets to use, where the content collections live, how the Astro site relates to the Go sync CLI, and which files are machine-generated and must not be hand-edited. Capturing that in AGENTS.md gives agents a single, durable entry point and removes the cost of re-discovering the layout on every session. CLAUDE.md is kept as a thin pointer (@AGENTS.md) so Claude Code picks up the same content without duplicating it.
We already had staticcheck and vet wired up, but golangci-lint bundles a much broader set of analyzers and is what CI-style Go projects typically reach for. Adding a dedicated 'make lint' target gives contributors (and agents) a one-shot way to run the aggregated linter locally without remembering the install incantation, and pins the version so results are reproducible. Also drops the missing trailing newline at EOF.
✅ Deploy Preview for nifty-bardeen-5c7e53 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
AGENTS.mdas the single orientation document for coding agents (Astro site layout, content collections, sync CLI, machine-generated files).CLAUDE.mdis kept as a thin@AGENTS.mdpointer so Claude Code picks up the same content without duplication.make linttowebsite-admin/Makefilerunning a pinnedgolangci-lint(v2.12.1) alongside the existingstaticcheck/vettargets.website-admin/Makefile.Test plan
cd website-admin && make lintinstalls golangci-lint and runs cleanlycd website-admin && make staticcheck vet teststill passAGENTS.mdandCLAUDE.mdin an agent session and confirm the pointer resolves