Skip to content

Latest commit

Β 

History

History
19 lines (15 loc) Β· 1.41 KB

File metadata and controls

19 lines (15 loc) Β· 1.41 KB

@AGENTS.md

Claude-Specific Notes

Claude Code also loads .claude/rules/ files that contain detailed coding instructions for specific topics:

  • code-generation.md β€” Guardrails for generated vs. hand-written files; which files get wiped on regeneration; where to submit changes
  • streaming.md β€” StreamingChannel patterns, goroutine leak prevention, context cancellation
  • error-handling.md β€” Error types, retry eligibility, status code behavior, retry-after header handling
  • telemetry.md β€” OpenTelemetry metric patterns, attributes, test setup with noop providers
  • oauth2-credentials.md β€” Token lifecycle, expiry jitter, credential patterns, RoundTripper wrapping
  • security.md β€” Security rules for credentials, oauth2, error handling, and HTTP client code
  • client-api.md β€” High-level client package conventions (fluent API, ULID validation, thread safety)
  • testing.md β€” Test conventions (t.Parallel, table-driven, testify, httpmock, race-safe)
  • go-conventions.md β€” Go coding standards (gofmt, golangci-lint, context propagation)
  • new-api-methods.md β€” Checklist for new public API methods (telemetry, operation name, SdkClient interface)
  • pr-conventions.md β€” Commit and PR conventions (conventional commits, make check)

When working on this SDK, consult both AGENTS.md (project context) and the applicable rules files (implementation guardrails).