-
Notifications
You must be signed in to change notification settings - Fork 246
Closed
Description
The repository-docs standard requires every SDK repo to have an AGENTS.md at the repository root. sentry-go currently has no AGENTS.md, meaning AI agents working in this repo have no architecture context, no testing conventions, no build instructions, and no SDK-specific standard overrides. The file that makes agentic contributions accurate and consistent.
What needs to be done
- Create
AGENTS.mdat the repo root. Use agents-md skill. - Create
CLAUDE.mdas a symlink:ln -s AGENTS.md CLAUDE.md - Fill in all SDK-specific sections:
- Package manager and key commands (
go build ./...,go test ./...,golangci-lint run,go vet ./...) - Architecture overview (flat package structure, framework integrations as subdirectories:
gin/,echo/,fiber/,fasthttp/,http/,otel/, etc.) - Development workflow (
go test ./...,golangci-lint runvia.golangci.yml,go vet,make) - Testing conventions (
_test.goalongside source, table-driven tests, race detector via-race, examples in_examples/) - Standards overrides (any known deviations from the SDK standards)
- Package manager and key commands (
- Verify accuracy: have an AI tool attempt a small contribution using the file as context before merging.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Fields
Give feedbackNo fields configured for issues without a type.